Skip to content

Commit

Permalink
Doc: update
Browse files Browse the repository at this point in the history
  • Loading branch information
HarimbolaSantatra committed Jan 26, 2025
1 parent 4c08402 commit cab82ca
Showing 1 changed file with 8 additions and 17 deletions.
25 changes: 8 additions & 17 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,32 @@

## Setup

The [the latest release][3] is the only stable version. Everything else is a work-in-progress as this project still has many in-progress or unresolved [issues][4].
The [the latest release][3] is the only stable version. Everything else is a
work-in-progress as this project still has many in-progress or unresolved
[issues][4].

### From the release
1. Download [the latest release][3] and copy
**BOTH** the binary (`mm`) and the scraping script (`mm-parsing`) to your
PATH.
2. Setup a python virtual environment (View above step)
2. Setup a python virtual environment (See below)
3. `./mm health`


### From source
Go is required. Follow the [installation instructions](https://go.dev/doc/install) if it's not installed yet.

1. Clone the repo: `git clone https://github.com/HarimbolaSantatra/mm-cli`
2. Setup a python virtual environment:
2. Setup a python virtual environment. For example:
```
mkdir ~/.python-venv
python3 -m venv ~/.python-venv/bs4
source ~/.python-venv/bs4/bin/activate
python3 -m pip install -r requirements.txt
```

3. Build the executable:

```
make
```

4. Check if everything is right

```
make test
./mm health
```
3. Run the tests: `make test`
4. Build and install the executable and the parsing script: `make install`
5. Test: `mm health`

## Usage

Expand Down Expand Up @@ -74,7 +66,6 @@ Use "mm [command] --help" for more information about a command.
## Acknowledgment
- Banner made with [ascii-banner](https://manytools.org/hacker-tools/ascii-banner/) - *Banner* font
- [Malagasy Word contributors](https://malagasyword.org/bins/contributors)
- Diagram made with [dia](http://dia-installer.de/)

[1]: https://malagasyword.org/bins/homePage
[2]: https://www.crummy.com/software/BeautifulSoup/bs4/doc/
Expand Down

0 comments on commit cab82ca

Please sign in to comment.