mirror of
https://codeberg.org/Yael-II/ArXtic.git
synced 2026-03-14 22:06:27 +01:00
2025-09-22: Added setup procedure
This commit is contained in:
20
README.md
20
README.md
@@ -1,5 +1,25 @@
|
||||
# ArXtic: ArXiv T I C
|
||||
|
||||
## Setup
|
||||
|
||||
Clone this repository with:
|
||||
```bash
|
||||
git clone https://codeberg.org/Yael-II/ArXtic/
|
||||
```
|
||||
Create a virtual environment with python using:
|
||||
```bash
|
||||
python3 -m venv venv
|
||||
```
|
||||
If you decide to use a different virtual environment, please change the `VENV_DIR` variable in `cfg/general_config.cfg`. Then, to allow the execution of the setup script, use:
|
||||
```bash
|
||||
chmod u+x setup.sh
|
||||
```
|
||||
and then run:
|
||||
```bash
|
||||
./setup.sh
|
||||
```
|
||||
Finally, you may want to add filters. For each field you want to filter, create a file in the `cfg/filters` directory. The fields that are filtered for each file is specified by `#FIELD="field_name"` in the file. Then, filtered keywords are listed, separated by a line break (one item per line). Then name of the file has no incidence (except for masked files using a `.` (dot), such as `.filename`, which are ignored).
|
||||
|
||||
## Licence
|
||||
|
||||
**ArXtic**
|
||||
|
||||
Reference in New Issue
Block a user