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

ox64 flashing added Archlinux commands #90

Closed
wants to merge 7 commits into from
Closed

Conversation

giorez
Copy link
Contributor

@giorez giorez commented Apr 29, 2024

No description provided.

@giorez giorez changed the title ox64 - flashing added Archlinux commands ox64 flashing added Archlinux commands Apr 29, 2024
@giorez
Copy link
Contributor Author

giorez commented Apr 30, 2024

@x1y please check my revision. thanks for helping me again.

[source,console]
----
sudo pacman -S python-pipenv
sudo pacman -S python-setuptools
Copy link
Collaborator

Choose a reason for hiding this comment

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

I still think python-setuptools is not required here. Where do you get an error and what error is it, if it is not installed?

NOTE: Each time you open a new terminal window you will need to re-run `. ~/ox64_venv/bin/activate` to reactivate the virtual environment.
In case you're on a system with Arch Linux, slightly adapt the commands:

[source,console]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Mind the "$" in front of the console commands in this block.

@@ -271,7 +271,18 @@ $ . ~/ox64_venv/bin/activate
$ pip install bflb-iot-tool # we are *not* using bflb-mcu-tool
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would change it to pipenv in those blocks too.

sudo pacman -S python-setuptools
pipenv install bflb-iot-tool # install CLI flash tool
pipenv shell # activate virtual enviroment
bflb-iot-tool --help # check info
Copy link
Collaborator

Choose a reason for hiding this comment

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

Mind that "--help" was just a shortened example from me

bflb-iot-tool --help # check info
----

NOTE: Each time you open a new terminal window you will need to re-run `. ~/ox64_venv/bin/activate` on Debian-based or `pipenv shell` on Archlinux systems to reactivate the virtual environment.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Command is "pipenv shell" for any system. It is not specific to a distribution and is better practice anyway, in contrast to the above installation methods without user flag.

Also: "Arch Linux", not "Archlinux".

@@ -261,7 +261,7 @@ You have a choice of flashing software:

=== CLI packages installation
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would strongly recommend to keep this one instruction for all distributions, not for random selected distributions. Steps are to install Pipenv, the library and then to change into the pipenv shell. If the packages are named differently then it can be mentioned as "Install packages x (under Debian it is called "x-x", under Arch it is called "xx") and y (under Debian it is called "y-y", under Arch it is called "yy").

Some basic knowledge can be generally imputed.

@x1y
Copy link
Collaborator

x1y commented Apr 30, 2024

Suggestion:

=== CLI packages installation

The `bflb-iot-tool` flashing tool can be installed as a Python library. This can be done in a virtual environment created with _pipenv_. First install pipenv via the package manager of your system. Create a folder where you want to create the virtual environment and change into the folder. Then install the library in a virtual environment with _pipenv install_ and then change into the virtual environment using _pipenv shell_:

[source,console]
----
$ pipenv install bflb-iot-tool
$ pipenv shell
$ bflb-iot-tool --help
----

Each time you want to return in the virtual environment, you can run `pipenv shell` in the folder.

@giorez
Copy link
Contributor Author

giorez commented May 1, 2024

closing this PR, since it's coming a new and updated one

@giorez giorez closed this May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants