<commit_before>QuartzFlow -- A Web-based Bittorrent Client
===========================================

A Web-based Bittorrent client that runs under Sinatra.

QuartzFlow runs as a standalone application which contains a web-server. For the rubyists, it uses Sinatra.


Installation
------------

`gem install quartz_flow`

Running
-------

### Quick Start

  1. Make a directory owned by the current user where you want QuartzFlow to run.
  2. Run `quartzflow setup` to set up the current directory.
  3. Run `quartzflow adduser --login someone` to add a user named `someone` (replace someone with a good username).
  4. Run `quartzflow start` or just `quartzflow` to run QuartzFlow.
  5. Open `localhost:4445/` with your browser and log in.
  6. When finished use CTRL-C to exit.
  7. (Optional) Edit `etc/quartz.rb` and change settings if desired. Restart after changes.

### Details

QuartzFlow expects to be run in a special directory called a "QuartzFlow Home". This is a regular directory that has 
had `quartzflow setup` run in it (that is, the command is run with the current directory being the directory to set up).
This setup creates the necessary directories, copies the needed HTML templates, creates an empty settings database, and 
creates default settings files. This setup only needs to be performed once per home, and from then on QuartzTorrent can 
be launched from that directory and use the configured settings.

A successfully setup QuartzTorrent home directory contains the following:

`etc/`

Static settings. These are things like what port to listen on, and how to log messages.

`db/`       

Dynamic settings. Under this directory is a SQLite database used to store settings that can be changed 
through the webpage.

`log/`      

Logs. By default, logs about torrent downloading and uploading are written here.

`public/, views/`   

Web files. These are the HTML templates, Javascript files, and CSS served when the app is running.

`meta/`     

Torrent metainformation. This is where downloaded and uploaded .torrent files are stored, and where Magnet
links are persisted.

`download/`

Downloaded Torrents. By default, downloaded torrent data is written to this directory.<commit_msg>Changed README wording<commit_after>QuartzFlow -- A Web-based Bittorrent Client
===========================================

A Web-based Bittorrent client. 

QuartzFlow runs as a standalone application which contains a web-server. For those familiar with ruby, it uses Sinatra
to run as a webserver.


Installation
------------

`gem install quartz_flow`

Running
-------

### Quick Start

  1. Make a directory owned by the current user where you want QuartzFlow to run.
  2. Run `quartzflow setup` to set up the current directory.
  3. Run `quartzflow adduser --login someone` to add a user named `someone` (replace someone with a good username).
  4. Run `quartzflow start` or just `quartzflow` to run QuartzFlow.
  5. Open `localhost:4445/` with your browser and log in.
  6. When finished use CTRL-C to exit.
  7. (Optional) Edit `etc/quartz.rb` and change settings if desired. Restart after changes.

### Details

QuartzFlow expects to be run in a special "home" directory. This is a regular directory that has 
had `quartzflow setup` run in it; that is, the command is run with the current directory being the directory to set up.
This setup creates the necessary environment needed for QuartzTorrent to run. It creates the required subdirectories, 
copies the HTML templates, creates an empty settings database, and creates default settings files. 
This setup only needs to be performed once per home, and from then on QuartzTorrent can 
be launched from that directory.

A successfully setup QuartzTorrent home directory contains the following:

`etc/`

Static settings. These are things like what port to listen on, and how to log messages.

`db/`       

Dynamic settings. Under this directory is a SQLite database used to store settings that can be changed 
through the webpage.

`log/`      

Logs. By default, logs about torrent downloading and uploading are written here.

`public/, views/`   

Web files. These are the HTML templates, Javascript files, and CSS served when the app is running.

`meta/`     

Torrent metainformation. This is where downloaded and uploaded .torrent files are stored, and where Magnet
links are persisted.

`download/`

Downloaded Torrents. By default, downloaded torrent data is written to this directory.

Use the command `quartzflow help` to get help for the various commands.
{'fraction_non_alphanumeric': 0.07856514084507042, 'fraction_numerical': 0.0048415492957746475, 'mean_word_length': 3.845415778251599, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 10, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1388047', 'n_tokens_mistral': 1245, 'n_tokens_neox': 1175, 'n_words': 653}