Prechádzať zdrojové kódy

propose readme template

jrobinAV 3 rokov pred
rodič
commit
4438cb0ecd
2 zmenil súbory, kde vykonal 36 pridanie a 5 odobranie
  1. 0 0
      INSTALLATION.md
  2. 36 5
      README.md

+ 0 - 0
INSTALLATION.md


+ 36 - 5
README.md

@@ -1,6 +1,37 @@
+# Taipy
 -> badges
--> license
--> What is Taipy
--> install
--> contributing
--> code_of conduct
+
+## license
+Copyright 2022 Avaiga Private Limited
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+       [http://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+
+## What is Taipy
+
+Taipy is a Python library for creating Business Applications. More information on our
+[website](https://www.taipy.io). Taipy is split into multiple repositories including _taipy-core_ so that a minimal
+installation can be performed.
+
+
+## Installation
+
+Want to install _Taipy_? Check out our [`INSTALLATION.md`](INSTALLATION.md) file.
+
+## Contributing
+
+Want to help build _Taipy_? Check out our [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
+
+## Code of conduct
+
+Want to be part of the _Taipy_ community? Check out our [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) file.
+
+## Directory Structure
+
+TODO