From 247745b7e759cf984dee6e9630053269dd29f5a9 Mon Sep 17 00:00:00 2001 From: INC Date: Tue, 31 Jan 2023 15:28:25 +0300 Subject: [PATCH] Fixing docs Issue #1033 (#1037) * Move the info in /pyscriptjs/README.md to /docs/development/developing.md * developing.md: Markdown linting * Fixing docs issue #1033 * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * setting-up-environment.md: Markdown Linting --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- docs/development/developing.md | 1 - docs/development/setting-up-environment.md | 48 ++++++++++++++++++++++ pyscriptjs/README.md | 39 +----------------- 3 files changed, 49 insertions(+), 39 deletions(-) diff --git a/docs/development/developing.md b/docs/development/developing.md index 40a98165..b3a64c28 100644 --- a/docs/development/developing.md +++ b/docs/development/developing.md @@ -80,7 +80,6 @@ Sometimes you might be asked to rebase main into your branch. Please refer to th If you need help with anything, feel free to reach out and ask for help! - ## pytest quick guide We make a heavy usage of `pytest`. Here is a quick guide and collection of diff --git a/docs/development/setting-up-environment.md b/docs/development/setting-up-environment.md index b88cf400..691bdf57 100644 --- a/docs/development/setting-up-environment.md +++ b/docs/development/setting-up-environment.md @@ -67,3 +67,51 @@ make livehtml ``` Visible here: [http://127.0.0.1:8000](http://127.0.0.1:8000) + +# PyScript Demonstrator + +A simple webapp to demonstrate the capabilities of PyScript. + +## Getting started + +1. If you don't already have Node.js, install it. The official installer for the + LTS version of Node is available from [nodejs.org](https://nodejs.org/). + +2. If you don't already have Rollup, install it. Rollup can be installed as a + global resource using: + + $ npm install --global rollup + +3. Install the demo apps requirements: + + $ npm install + +4. Start the server: + + $ npm run dev + + This will compile the resources for the app, and start the development server. + +5. When the compilation completes, it will display something like: + + Your application is ready~! 🚀 + + - Local: http://localhost:8080 + - Network: Add `--host` to expose + + ────────────────── LOGS ────────────────── + + Once this is visible, open a browser at + [http://localhost:8080](http://localhost:8080). This will provide a list of + demos that you can run. + +## More information + +For more information: + +* [Discussion board](https://community.anaconda.cloud/c/tech-topics/pyscript) +* [Home Page](https://pyscript.net/) +* [Blog Post](https://engineering.anaconda.com/2022/04/welcome-pyscript.html) +* [Discord Channel](https://discord.gg/BYB2kvyFwm) + +We use Discord as the main place for our discussions diff --git a/pyscriptjs/README.md b/pyscriptjs/README.md index 6fd8fb25..afbcd9e4 100644 --- a/pyscriptjs/README.md +++ b/pyscriptjs/README.md @@ -1,40 +1,3 @@ # PyScript Demonstrator -A simple webapp to demonstrate the capabilities of PyScript. - -## Getting started - -1. If you don't already have Node.js, install it. The official installer for the - LTS version of Node is available from [nodejs.org](https://nodejs.org/). - -2. If you don't already have Rollup, install it. Rollup can be installed as a - global resource using: - - $ npm install --global rollup - -3. Install the demo apps requirements: - - $ npm install - -4. Start the server: - - $ npm run dev - - This will compile the resources for the app, and start the development server. - -5. When the compilation completes, it will display something like: - - Your application is ready~! 🚀 - - - Local: http://localhost:8080 - - Network: Add `--host` to expose - - ────────────────── LOGS ────────────────── - - Once this is visible, open a browser at - [http://localhost:8080](http://localhost:8080). This will provide a list of - demos that you can run. - -## More information - -There is a forum PyScript where you can discuss the project or ask questions at [https://community.anaconda.cloud/c/pyscript](https://community.anaconda.cloud/c/pyscript) +[A simple webapp to demonstrate the capabilities of PyScript.](https://github.com/pyscript/pyscript/blob/main/docs/development/setting-up-environment.md#pyscript-demonstrator)