Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated readme.md with setup "Working on the content" instructions for armbian 24.5.1  #437

Merged
merged 3 commits into from
Jul 18, 2024

Conversation

Tearran
Copy link
Contributor

@Tearran Tearran commented Jun 26, 2024

System

Armbian 24.5.1 Bookworm with Linux 6.6.31-current-meson64
added bash procedure used to build document in readme.
Followed readme tutorial readme bash procedure did not work for me on fresh image of Armbian 24.5.1 Bookworm

what procedure did worked

{
sudo apt-get update
sudo apt-get install python3 python3-pip python3-venv python3.11-dev
}

followed by

{
git clone https://github.com/armbian/documentation
cd documentation
python3 -m venv $HOME/.local/armbian-docs-env 
source $HOME/.local/armbian-docs-env/bin/activate
$HOME/.local/armbian-docs-env/bin/pip install -r requirements.txt
mkdocs build --clean && mkdocs serve
}

Lastly

This shows a the expected webpage on given url:port

python3 tools/mkArmbianDocs.py && mkdocs build 
mkdocs serve

resulted

chromium  http://127.0.0.1:8000/User-Guide_Armbian-ConfigNG/
image

Copy link
Member

@rpardini rpardini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good. I'd keep the venv inside the repo (and .gitignore'd) but that's just me

@igorpecovnik
Copy link
Member

i think this part can be merged - perhaps fix the title to say more specific what it does.

@Tearran Tearran changed the title Bash procedures update (draft) updated readme setup instructions for armbian 24.5.1  Jul 1, 2024
@Tearran Tearran changed the title updated readme setup instructions for armbian 24.5.1  updated readme.md with setup instructions for armbian 24.5.1  Jul 1, 2024
@Tearran Tearran changed the title updated readme.md with setup instructions for armbian 24.5.1  updated readme.md with setup "Working on the content" instructions for armbian 24.5.1  Jul 2, 2024
changed virtual environment location to repository
@Tearran
Copy link
Contributor Author

Tearran commented Jul 2, 2024

@rpardini your suggestion makes practical sense. and looking at existing .gitignore made compatible changes. quick test had similar results.

{
git clone https://github.com/armbian/documentation
cd documentation
python3 -m venv .venv
source .venv/bin/activate
}

@igorpecovnik igorpecovnik merged commit dd70d45 into armbian:master Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants