Add directory structure to Readme & add readme to PyPI (stanford-crfm#1901)

Author: farzaank

README.md

@@ -1,4 +1,5 @@
 <!--intro-start-->
+
 # Holistic Evaluation of Language Models
 
 [comment]: <> (When using the img tag, which allows us to specify size, src has to be a URL.)
@@ -15,3 +16,34 @@ Welcome! The **`crfm-helm`** Python package contains code used in the **Holistic
 <!--intro-end-->
 
 To get started, refer to [the documentation on Read the Docs](https://crfm-helm.readthedocs.io/) for how to install and run the package.
+
+## Directory Structure
+
+The directory structure for this repo is as follows
+
+├── docs # MD used to generate readthedocs
+│
+├── scripts # Python utility scripts for HELM
+│ ├── cache
+│ ├── data_overlap # Calculate train test overlap
+│ │ ├── common
+│ │ ├── scenarios
+│ │ └── test
+│ ├── efficiency
+│ ├── fact_completion
+│ ├── offline_eval
+│ └── scale
+└── src
+├── helm # Benchmarking Scripts for HELM
+│ │
+│ ├── benchmark # Main Python code for running HELM
+│ │ │
+│ │ └── static # Current JS (Jquery) code for rendering front-end
+│ │ │
+│ │ └── ...
+│ │
+│ ├── common # Additional Python code for running HELM
+│ │
+│ └── proxy # Python code for external web requests
+│
+└── helm-frontend # New React Front-end

setup.cfg

@@ -4,7 +4,8 @@ version = 0.2.4
 author = Stanford CRFM
 author_email = [email protected]
 description = Benchmark for language models
-long_description = Benchmark for language models
+long_description = file: README.md, docs/tutorial.md
+long_description_content_type = text/markdown
 keywords = language models benchmarking
 license = Apache License 2.0
 classifiers =