mirror of
https://codeberg.org/Yael-II/ArXtic.git
synced 2026-03-15 06:16:26 +01:00
38 lines
1.7 KiB
Markdown
38 lines
1.7 KiB
Markdown
<!--[TLP:WHITE] UNLIMITED DISTRIBUTION-->
|
|
```diff
|
|
[TLP:WHITE] UNLIMITED DISTRIBUTION
|
|
```
|
|
# ArXtic: ArXiv (and ADS) Tool for Importing and Curating Bibliography
|
|
|
|
## 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 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**
|
|
|
|
Copyright (C) 2025 Yaël Moussouni (yael.moussouni@etu.unistra.fr)
|
|
|
|
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License along with this program. If not, see www.gnu.org/licenses/.
|