Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ivanhb authored Jul 26, 2024
1 parent 25e7960 commit c1859b7
Showing 1 changed file with 2 additions and 21 deletions.
23 changes: 2 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[<img src="https://img.shields.io/badge/powered%20by-OpenCitations-%239931FC?labelColor=2D22DE" />](http://opencitations.net) [![Python package](https://github.com/opencitations/index/actions/workflows/python-package.yml/badge.svg?branch=farm_revision)](https://github.com/opencitations/index/actions/workflows/python-package.yml)
# OpenCitations: Index

This software allows the creation of indexes of open citations (e.g. COCI).
This software allows the production of the OpenCitations index
## Requirements
### Mandatory
- Python 3.7+
Expand All @@ -10,27 +10,10 @@ This software allows the creation of indexes of open citations (e.g. COCI).
- Redis (* mandatory for redis data source), see [Installing Redis](https://redis.io/docs/getting-started/installation/) for additional information.
## Install
To install the index software you must first meet all the requirements above.

1. First of all let's compile the cpp source files for the OCI lookup management
```console
$ make build
```
2. Then install the binaries and add them to the $PATH
```console
$ sudo make install
```
3. As a last step the python package must be installed, at the same time all the python scripts will be added to the $PATH
Then the python package must be installed, this adds all the python scripts to the $PATH
```console
$ pip install .
```

4. To ensure that the installation has been carried out correctly start the tests
```console
$ python -m unittest discover -s ./index/python/test -p "test_*.py"
```

Done, enjoy :)

## Configuration
By default when index is installed a configuration file is created in ~/.opencitations/index/, namely config.ini. For more information about the semantics of the settings see [config.ini](config.ini).

Expand All @@ -40,7 +23,5 @@ See [Usage](USAGE.md).
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
OpenCitations Index is released under the [ISC License](LICENSE).

0 comments on commit c1859b7

Please sign in to comment.