Merge pull request #1 from alecrem/add-readme

README.md

@@ -0,0 +1,25 @@
+# middleschool-cardlist
+
+Composes a list of Magic cards legal in the Middle School format 
+
+## The process: the Jupyter notebook
+
+Feel free to take a look at [the notebook](https://github.com/alecrem/middleschool-cardlist/blob/main/middleschool-cardlist.ipynb)
+
+### Requirements to run the notebook
+
+Command line utilities:
+
+- [wget](https://www.gnu.org/software/wget/)
+- [bzip2](https://sourceware.org/bzip2/)
+- [jq](https://stedolan.github.io/jq/)
+
+Python modules:
+
+- json
+- pandas
+
+## The result: output files
+
+- [middleschool.json ](https://github.com/alecrem/middleschool-cardlist/blob/main/output/middleschool.json)
+- [middleschool.csv](https://github.com/alecrem/middleschool-cardlist/blob/main/output/middleschool.csv)

middleschool-cardlist.ipynb

@@ -206,6 +206,13 @@
     "middleschool_df.to_csv('output/middleschool.csv')\n",
     "middleschool_df.to_json('output/middleschool.json')\n"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Feel free to delete everything in the `data` directory after you are done"
+   ]
   }
  ],
  "metadata": {