From ec96dad06a2b9987260cde4500450b2d3e64bcaf Mon Sep 17 00:00:00 2001 From: Cade Brown Date: Tue, 20 Sep 2016 23:08:19 -0400 Subject: [PATCH] Updated readme and uploaded example.workload --- .gitignore | 32 ++++++------- README.md | 96 +++++++++++++++++--------------------- workloads/.gitignore | 3 +- workloads/example.workload | 1 + 4 files changed, 60 insertions(+), 72 deletions(-) create mode 100644 workloads/example.workload diff --git a/.gitignore b/.gitignore index 11f2e49..1934231 100644 --- a/.gitignore +++ b/.gitignore @@ -1,33 +1,29 @@ -*.o -*.out -*.pyc -*.credentials -!/program/example.credentials +# Ignore all prefs except the example one *.prefs !example.prefs -/node_modules/ -/NodePGS/node_modules/ -/tmp/ -/run.build/ -/workloads/* -!/workloads/test.workload -# Output directory -/output/* -!/output/ +# All compiled C programs +*.o +*.out # Prime sieve *.dat +# Ignore tmp directory for building +/tmp/ + # Zipped and compiled versions /build/ -# VScode editor -*.vscode - # JavaPGS netbeans and whatnot /JPGS/build/ /JPGS/nbproject/ /JPGS/test/ /nbproject/private/ -/JPGS/dist/ \ No newline at end of file +/JPGS/dist/ + +# Ignore all npm installed packages +/node_modules/ + +# VScode editor +*.vscode \ No newline at end of file diff --git a/README.md b/README.md index 778a660..e1fd99a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + + ██████╗ ██████╗ ███████╗ ██╔══██╗██╔════╝ ██╔════╝ ██████╔╝██║ ███╗███████╗ @@ -5,6 +7,23 @@ ██║ ╚██████╔╝███████║ ╚═╝ ╚═════╝ ╚══════╝ + +## Features + +### Planned + * GUI Application (Was removed) + +### Implemented + * Multithreaded - Specify `in my.prefs` + * Link with DB for users to help search + * OpenCL - Look in folder `JPGS`. + +### Removed + * JavaPGS + * GUI Application (Also going to be implemented) + * OpenCL - Too buggy, and multithreaded is better performance + + ## What is this? This is a project that searches for functions that are prime for the first few values of input. It is a **P**rime **G**enerator **S**earch. It looks through polynomials, and reports it's findings to the server. @@ -21,6 +40,26 @@ To download the project, please check out (http://chemicaldevelopment.us/pgs). If you would like to help develop the project, you can reach me at info@chemicaldevelopment.us +## Explanation +For a more in-detail explanation, see our wiki (https://github.com/ChemicalDevelopment/PGS/wiki), but here's a short explanation: + + +Primes are numbers that can't be made from multiplying two other integers together. The first few primes are 2, 3, 5, 7, 11, 13. A few example functions that return primes for the first few values are: + + +`2x + 3` +from x = [0 to 2] + + +`x^2 + x + 41` +from x = [0 to 39] + +That last one is prime for 40 consecutive values + + +This program looks for larger and longer examples of this, and does it over the internet over multiple computers. + + ## Running ### Releases (Default) [Sign Up](http://chemicaldevelopment.us/pgs/account) for an account @@ -41,8 +80,6 @@ Double click `PGS.exe` Double click `PGS` - - Run a shell in any OS, and run `./PGS` or `./PGS.exe` with some flags found on the (wiki)[https://github.com/ChemicalDevelopment/PGS/wiki]. @@ -55,52 +92,22 @@ For the default install script, run ./install.sh ``` -Then, to run the program: +To run the program: ``` node PGS.js --offline ``` Or, if you would like to run a version that reports the the server, -You need to create an account at (http://chemicaldevelopment.us/pgs/client), and then fill in your email and password (without "{{" or "}}") (git ignores any .prefs files except for example.pref) +You need to create an account at (http://chemicaldevelopment.us/pgs/client) -Then, use your text editor to open `./my.prefs`, and change the email and password -``` -{ - "RUN_FILE": "./run_c.sh", - "PRIME_FILE": "./primes.dat", - "email": "{{email}}", - "password": "{{password}}", - "workload_preference": "random", - "threads": 2 -} +Use your text editor to open `./my.prefs`, and change the email and password -``` Then, ``` node PGS.js ``` - -## Explanation -For a more in-detail explanation, see our wiki (https://github.com/ChemicalDevelopment/PGS/wiki), but here's a short explanation: - - -Primes are numbers that can't be made from multiplying two other integers together. The first few primes are 2, 3, 5, 7, 11, 13. A few example functions that return primes for the first few values are: - - -`2x + 3` -from x = [0 to 2] - - -`x^2 + x + 41` -from x = [0 to 39] - -That last one is prime for 40 consecutive values - - -This program looks for larger and longer examples of this, and does it over the internet over multiple computers. - ## More Info More info can be found on our wiki (https://github.com/ChemicalDevelopment/PGS/wiki) @@ -110,21 +117,4 @@ Website: (http://chemicaldevelopment.us/pgs) Online Client: (http://chemicaldevelopment.us/pgs/client/) -Account Manager: (http://chemicaldevelopment.us/pgs/client/account/) - - - -## Features - -### Planned - * GUI Application (Was removed) - -### Implemented - * Multithreaded - Specify `in my.prefs` - * Link with DB for users to help search - * OpenCL - Look in folder `JPGS`. - -### Removed - * JavaPGS - * GUI Application (Also going to be implemented) - * OpenCL - Too buggy, and multithreaded is better performance \ No newline at end of file +Account Manager: (http://chemicaldevelopment.us/pgs/client/account/) \ No newline at end of file diff --git a/workloads/.gitignore b/workloads/.gitignore index 6e5059a..4260dc3 100644 --- a/workloads/.gitignore +++ b/workloads/.gitignore @@ -1,6 +1,7 @@ # Ignore everything in this directory * -# Except this file +# Except this file and example !.gitignore +!example.workload # This way, cloners will have a workloads directory \ No newline at end of file diff --git a/workloads/example.workload b/workloads/example.workload new file mode 100644 index 0000000..1d94497 --- /dev/null +++ b/workloads/example.workload @@ -0,0 +1 @@ +{"offsets":[0,0,0],"ranges":[1000,1000,1000]} \ No newline at end of file