Testing github pages

Edouard360 · Oct 5, 2017 · 6ced66b · 6ced66b
1 parent 17ff28d
commit 6ced66b
Show file tree

Hide file tree

Showing 19 changed files with 63 additions and 834 deletions.
diff --git a/docs/Gemfile b/docs/Gemfile
diff --git a/docs/README.md b/docs/README.md
@@ -1,69 +1,3 @@
-# Jekyll Cayman theme
+# Documentation
 
-This is a [Jekyll][1] theme for [@jasonlong][2]'s [Cayman theme][4] on [GitHub Pages][3].
-
-Cayman is a clean, responsive theme for [GitHub Pages](https://pages.github.com). This theme is available as an option if you use the [Automatic Page Generator](https://help.github.com/articles/creating-pages-with-the-automatic-generator/) or you can copy the template and styles to use on your own.
-
-You can preview the theme at http://jasonlong.github.io/cayman-theme or with real content at http://jasonlong.github.io/geo_pattern.
-
-![](http://cl.ly/image/1T3r3d18311V/content)
-
-# How to use it?
-
-Download the theme @ http://github.com/pietromenna/jekyll-cayman-theme/archive/master.zip
-
-Unzip it and use it as a regular jekyll folder.
-
-```
-$ unzip jekyll-cayman-theme-master.zip
-```
-
-Get inside the newly extracted folder
-```
-$ cd jekyll-cayman-theme-master
-```
-
-Get the required gems
-```
-$ bundle install
-```
-
-Use it!
-
-```
-$ jekyll serve
-```
-
-For more details read about [Jekyll][1] on its web page.
-
-# Setup
-
-Some important configuration can be done in the file `_config.yml`. Please, check the Setup section in that file.
-
-
-## baseurl
-
-`baseurl` parameter is required in the case the site doesn't sit on the root of the domain. For example: http://pietromenna.github.io/jekyll-cayman-theme
-
-In the case above the baseurl should be set to "/jekyll-cayman-theme".
-
-In the case the site sits in the root, you can leave `baseurl` as empty "".
-
-# Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/pietromenn/jekyll-cayman-theme.
-
-# Development
-
-To set up your environment to develop this theme, run `bundle install`.
-
-Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
-
-# License
-
-This work is licensed under a [Creative Commons Attribution 4.0 International](http://creativecommons.org/licenses/by/4.0/) license.
-
-[1]: http://jekyllrb.com/
-[2]: https://github.com/jasonlong
-[3]: http://pages.github.com/
-[4]: https://github.com/jasonlong/cayman-theme
+To see the docs, click [here](http://creativecommons.org/licenses/by/4.0/).
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,35 +1,14 @@
 # Setup
-title:        Project or Test name
-tagline:      A responsive theme for your project on GitHub Pages
-#baseurl:      ""
-#paginate:     1
+theme: jekyll-theme-cayman
 
-# About/contact
-author:
-  name:       Author name
-  url:        http://yourhomepage.com
-
-# Gems
-#gems:
-#  - jekyll-paginate
-
-#Others
-#markdown: kramdown
+title:        Text Mining Challenge
+tagline:      A data science project
 
-theme: jekyll-theme-slate
-
-#defaults:
-#  - scope:
-#      path: ""
-#      type: my_collection
-#    values:
-#      layout: page
+author:
+  name:       Edouard Mehlman
+  url:        edouard.mehlman@polytechnique.edu
 
-#collections:
-#  my_collection:
-#    output: true
-#    permalink: /:collection/:name
 collections:
-  my_collection:
+  documentation:
     output: true
     permalink: /:collection/:name # This is just display
diff --git a/docs/_documentation/first_steps.md b/docs/_documentation/first_steps.md
@@ -0,0 +1,40 @@
+---
+layout: default
+title:  "First Steps"
+
+---
+
+
+## Run the Bot
+
+In your console:
+
+`cd networking python start_game.py`
+
+In another tab
+
+`cd public python MyBot.py`
+
+This will run 1 game. Options can be added to starting the game, among which:
+
+`python start_game.py -g 5 -x 30 -z 50`
+
+Will run 5 games, of at most 30 turns, which at most squares of strength 50.
+
+## Visualize the Bot
+
+In your console:
+
+`cd visualize export FLASK_APP=visualize.py;flask run`
+
+Then either:
+
+Look at http://127.0.0.1:5000/performance.png for performance insights.
+
+Or at http://127.0.0.1:5000/ for games replay.
+
+## Working with PyCharm
+
+To run the Bot in Pycharm, you should provide a **mute** argument, since `MyBot.py` needs to know it's not on the Halite server, but running locally. 
+
+Go to edit configuration and add the script argument `slave` (so that the bot knows it is in slave mode).
diff --git a/docs/_includes/head.html b/docs/_includes/head.html
diff --git a/docs/_includes/page-footer.html b/docs/_includes/page-footer.html
diff --git a/docs/_includes/page-header.html b/docs/_includes/page-header.html
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html
diff --git a/docs/_layouts/post.html b/docs/_layouts/post.html
diff --git a/docs/_posts/2016-02-12-sample-content.markdown b/docs/_posts/2016-02-12-sample-content.markdown
diff --git a/docs/_posts/2017-02-12-sample-content.markdown b/docs/_posts/2017-02-12-sample-content.markdown
diff --git a/docs/_posts/2017-09-26-simple-approach.markdown b/docs/_posts/2017-09-26-simple-approach.markdown
@@ -0,0 +1,6 @@
+---
+layout: default
+title:  "A simple approach"
+date:   2016-02-12 17:50:00
+categories: main
+---
diff --git a/docs/_posts/2018-02-12-sample-content.markdown b/docs/_posts/2018-02-12-sample-content.markdown
diff --git a/docs/_posts/2019-02-12-BITCH.markdown b/docs/_posts/2019-02-12-BITCH.markdown