Skip to content

Commit

Permalink
update documents and publish workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
yuiseki committed Dec 20, 2023
1 parent 1bd2d05 commit b1329d7
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ jobs:
- uses: actions/setup-node@v3
with:
tag_name: 'v%s'
node-version: '14.x'
node-version: '18.x'
registry-url: 'https://registry.npmjs.org'
scope: '@unvt'
- run: npm install
Expand Down
2 changes: 1 addition & 1 deletion docs/source/install/install.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Install
=======
Make sure that npm and nodejs are installed. Nodeis version 14 or later version are recommended. Then, install charites by running the following command:
Make sure that npm and nodejs are installed. Nodeis version 18 or later version are recommended. Then, install charites by running the following command:

.. code-block:: bash
Expand Down
8 changes: 4 additions & 4 deletions docs/source/install/installation_guide_for_windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ Steps

Step 1. Installation of nodejs (if it is not installed yet)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check if nodejs is installed. If not, visit `nodejs <https://nodejs.org/en/>`_ to install them. Version 14 or later version is recommended. Installation will fail with the older version of nodejs than 12.20.0.
Check if nodejs is installed. If not, visit `nodejs <https://nodejs.org/en/>`_ to install them. Version 18 or later version is recommended. Installation will fail with the older version of nodejs than 12.20.0.

Step 2. Open Windows PowerShell
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Open Windows PowerShell and confirm if nodejs and npm works.

.. code-block::
.. code-block::
npm --version
node --version
Expand All @@ -30,7 +30,7 @@ Step 3. Install @unvt/charites as a npm package
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Just rung the following command to install the charites.

.. code-block::
.. code-block::
npm install -g @unvt/charites
Expand All @@ -39,7 +39,7 @@ Step 4. Confirm if charites is properly installed
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you can see the charites version and command lits with the following command. It seems that your installation has done successfully.

.. code-block::
.. code-block::
charites --version
charites --help
Expand Down
2 changes: 1 addition & 1 deletion docs/source/install/recommended_environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Recommended environment

Chrities may work well on OSX, Ubuntu, Windows 10 and Raspberry Pi.

Nodejs and npm are needed to install charites. Docker can also be a good environment in Windows while WSL might work well. For charites version 0.3.0 released in December 2022, nodejs ver 14. or later version is recommended.
Nodejs and npm are needed to install charites. Docker can also be a good environment in Windows while WSL might work well. For charites version 0.3.0 released in December 2022, nodejs ver 18. or later version is recommended.

0 comments on commit b1329d7

Please sign in to comment.