added README.rst

sundarnagarajan · Mar 26, 2016 · 7d67940 · 7d67940
1 parent 2b19981
commit 7d67940
Show file tree

Hide file tree

Showing 3 changed files with 90 additions and 85 deletions.
diff --git a/README.md b/README.md
@@ -32,34 +32,35 @@ toplevel --> python package name
 This setup.py assumes following layout.
 
 This directory
-├── setup.py - this file
-├── setupext.py - required in this directory
-├── LICENSE - typical for github etc but not required
-│       Hard-link to a file under data_dirX to keep at top level
-│       and also install the same file
-│
-├── README.rst - typical for github etc but not requiredt
-│       Hard-link to a file under data_dirX to keep at top level
-│       and also install the same file
-│
-└── toplevel - python package name
-    ├── toplevel.__init__.py
-    ├── toplevel.module1.py
-    ├── toplevel.module2py
-    │
-    ├── subpkg1
-    │   ├── subpkg1.module1.py
-    │   ├── subpkg1.__init__.py
-    │   └── subpkg1.module2.py
-    │
-    ├── data_dir1 - e.g. c_files
-    │   ├── data_dir1_file1
-    │   ├── data_dir1_file2
-    │   └── data_dir1_file3
-    │
-    └── data_dir2 - e.g. doc
-        ├── data_dir2_file1 - e.g. LICENSE
-        └── data_dir2_file2 - e.g. README.rst
+
+	├── setup.py - this file
+	├── setupext.py - required in this directory
+	├── LICENSE - typical for github etc but not required
+	│       Hard-link to a file under data_dirX to keep at top level
+	│       and also install the same file
+	│
+	├── README.rst - typical for github etc but not requiredt
+	│       Hard-link to a file under data_dirX to keep at top level
+	│       and also install the same file
+	│
+	└── toplevel - python package name
+	    ├── toplevel.__init__.py
+	    ├── toplevel.module1.py
+	    ├── toplevel.module2py
+	    │
+	    ├── subpkg1
+	    │   ├── subpkg1.module1.py
+	    │   ├── subpkg1.__init__.py
+	    │   └── subpkg1.module2.py
+	    │
+	    ├── data_dir1 - e.g. c_files
+	    │   ├── data_dir1_file1
+	    │   ├── data_dir1_file2
+	    │   └── data_dir1_file3
+	    │
+	    └── data_dir2 - e.g. doc
+	        ├── data_dir2_file1 - e.g. LICENSE
+	        └── data_dir2_file2 - e.g. README.rst
 
 
 If your layout is different, you may need to make changes to the following:

diff --git a/README.rst b/README.rst
@@ -42,35 +42,38 @@ toplevel --> python package name
 
 This setup.py assumes following layout.
 
-| This directory
-| ├── setup.py - this file
-| ├── setupext.py - required in this directory
-| ├── LICENSE - typical for github etc but not required
-| │ Hard-link to a file under data\_dirX to keep at top level
-| │ and also install the same file
-| │
-| ├── README.rst - typical for github etc but not requiredt
-| │ Hard-link to a file under data\_dirX to keep at top level
-| │ and also install the same file
-| │
-| └── toplevel - python package name
-|     ├── toplevel.\ **init**.py
-|     ├── toplevel.module1.py
-|     ├── toplevel.module2py
-|  │
-|     ├── subpkg1
-|     │   ├── subpkg1.module1.py
-|     │   ├── subpkg1.\ **init**.py
-|     │   └── subpkg1.module2.py
-|  │
-|     ├── data\_dir1 - e.g. c\_files
-|     │   ├── data\_dir1\_file1
-|     │   ├── data\_dir1\_file2
-|     │   └── data\_dir1\_file3
-|  │
-|     └── data\_dir2 - e.g. doc
-|        ├── data\_dir2\_file1 - e.g. LICENSE
-|        └── data\_dir2\_file2 - e.g. README.rst
+This directory
+
+::
+
+    ├── setup.py - this file
+    ├── setupext.py - required in this directory
+    ├── LICENSE - typical for github etc but not required
+    │       Hard-link to a file under data_dirX to keep at top level
+    │       and also install the same file
+    │
+    ├── README.rst - typical for github etc but not requiredt
+    │       Hard-link to a file under data_dirX to keep at top level
+    │       and also install the same file
+    │
+    └── toplevel - python package name
+        ├── toplevel.__init__.py
+        ├── toplevel.module1.py
+        ├── toplevel.module2py
+        │
+        ├── subpkg1
+        │   ├── subpkg1.module1.py
+        │   ├── subpkg1.__init__.py
+        │   └── subpkg1.module2.py
+        │
+        ├── data_dir1 - e.g. c_files
+        │   ├── data_dir1_file1
+        │   ├── data_dir1_file2
+        │   └── data_dir1_file3
+        │
+        └── data_dir2 - e.g. doc
+            ├── data_dir2_file1 - e.g. LICENSE
+            └── data_dir2_file2 - e.g. README.rst
 
 | If your layout is different, you may need to make changes to the
 following:

diff --git a/setupext/doc/README.txt → setupext/doc/README.md b/setupext/doc/README.txt → setupext/doc/README.md
@@ -32,34 +32,35 @@ toplevel --> python package name
 This setup.py assumes following layout.
 
 This directory
-├── setup.py - this file
-├── setupext.py - required in this directory
-├── LICENSE - typical for github etc but not required
-│       Hard-link to a file under data_dirX to keep at top level
-│       and also install the same file
-│
-├── README.rst - typical for github etc but not requiredt
-│       Hard-link to a file under data_dirX to keep at top level
-│       and also install the same file
-│
-└── toplevel - python package name
-    ├── toplevel.__init__.py
-    ├── toplevel.module1.py
-    ├── toplevel.module2py
-    │
-    ├── subpkg1
-    │   ├── subpkg1.module1.py
-    │   ├── subpkg1.__init__.py
-    │   └── subpkg1.module2.py
-    │
-    ├── data_dir1 - e.g. c_files
-    │   ├── data_dir1_file1
-    │   ├── data_dir1_file2
-    │   └── data_dir1_file3
-    │
-    └── data_dir2 - e.g. doc
-        ├── data_dir2_file1 - e.g. LICENSE
-        └── data_dir2_file2 - e.g. README.rst
+
+	├── setup.py - this file
+	├── setupext.py - required in this directory
+	├── LICENSE - typical for github etc but not required
+	│       Hard-link to a file under data_dirX to keep at top level
+	│       and also install the same file
+	│
+	├── README.rst - typical for github etc but not requiredt
+	│       Hard-link to a file under data_dirX to keep at top level
+	│       and also install the same file
+	│
+	└── toplevel - python package name
+	    ├── toplevel.__init__.py
+	    ├── toplevel.module1.py
+	    ├── toplevel.module2py
+	    │
+	    ├── subpkg1
+	    │   ├── subpkg1.module1.py
+	    │   ├── subpkg1.__init__.py
+	    │   └── subpkg1.module2.py
+	    │
+	    ├── data_dir1 - e.g. c_files
+	    │   ├── data_dir1_file1
+	    │   ├── data_dir1_file2
+	    │   └── data_dir1_file3
+	    │
+	    └── data_dir2 - e.g. doc
+	        ├── data_dir2_file1 - e.g. LICENSE
+	        └── data_dir2_file2 - e.g. README.rst
 
 
 If your layout is different, you may need to make changes to the following: