From 51eb80ea76975e808fd981874b8a6eaa1e6f54af Mon Sep 17 00:00:00 2001 From: LG Date: Sun, 9 Jan 2022 14:59:37 +0000 Subject: [PATCH 01/13] feat: first commit i am backing up --- docs/docs/{CONTRIBUTING.MD => CONTRIBUTING.md} | 10 ++++++---- docs/docs/Compiling TimerX from source.md | 8 ++++++++ docs/docs/intro.md | 4 +--- docs/docusaurus.config.js | 2 +- 4 files changed, 16 insertions(+), 8 deletions(-) rename docs/docs/{CONTRIBUTING.MD => CONTRIBUTING.md} (88%) create mode 100644 docs/docs/Compiling TimerX from source.md diff --git a/docs/docs/CONTRIBUTING.MD b/docs/docs/CONTRIBUTING.md similarity index 88% rename from docs/docs/CONTRIBUTING.MD rename to docs/docs/CONTRIBUTING.md index e414f017..425522c9 100644 --- a/docs/docs/CONTRIBUTING.MD +++ b/docs/docs/CONTRIBUTING.md @@ -1,13 +1,15 @@ --- sidebar_position: 2 +id: contributing +title: Contributing to TimerX --- # Contributing to TimerX TimerX is written in **Python**, so you have to install it if you want to contribute. You can download the latest version from [here](https://www.python.org/downloads/). -Make sure to check `Add Python 3.10 to path` when installing it. -After installing Python, get [Git](https://git-scm.org). It's version control, so that will help you in adding your changes over here. +Make sure to check `Add Python 3.10 to PATH` when installing it. +After installing Python, install [Git](https://git-scm.org). It's version control, so that will help you in adding your changes over here. Click the `Fork` button on the top-right in the GitHub page. Give it a few seconds to fork TimerX and then execute these series of commands in your Terminal/Command Prompt. ```shell git clone https://github.com/your-username/TimerX && cd TimerX @@ -29,7 +31,7 @@ The environment is building itself. You'll have to wait for at least 2 minutes, #### 4. Start coding! When Gitpod loads, you will be greeted by a VS Code UI. You could start coding immediately. But be wary - the commits are forced to be semantic. Fortunately, we have a CLI tool called `cz` that could help you on committing. #### Ready to commit? -First, create a new branch. Name it in a way that it tells your feature in a short, abstract way. After creating your branch, open a new terminal(Ctrl + `. +First, create a new branch. Name it in a way that it tells your feature in a short, abstract way. After creating your branch, open a new terminal by typing Ctrl + `. The ` symbol is beside the number 1 key or right above the Tab key. Then, type these commands: ```shell @@ -40,4 +42,4 @@ It will ask you what type of change it is, the scope(just hit enter) and the com ```shell git push ``` -After that, you can open a PR [here](https://github.com/sumeshir26/TimerX/pulls) and a reviewer will review it soon. \ No newline at end of file +After that, you can open a PR [here](https://github.com/sumeshir26/TimerX/pulls/new). Choose your branch and open it and a reviewer will review it soon. \ No newline at end of file diff --git a/docs/docs/Compiling TimerX from source.md b/docs/docs/Compiling TimerX from source.md new file mode 100644 index 00000000..1828aa33 --- /dev/null +++ b/docs/docs/Compiling TimerX from source.md @@ -0,0 +1,8 @@ +--- +sidebar_position: 3 +--- + +# Compiling TimerX from source +Before compiling, make soure you have [Python 3.x](https://python.org/downloads/ and optionally [Git](https://git-scm.org) installed; we recommend you to use Python 3.10 for compiling TimerX. +## Step 1 +Open your terminal and head to the TimerX folder; if you have Git, clone it with `git clone https://github.com/sumeshir26/TimerX.git` or download the ZIP \ No newline at end of file diff --git a/docs/docs/intro.md b/docs/docs/intro.md index a48d22b4..ef0119d4 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -1,5 +1,3 @@ --- sidebar_position: 1 ---- - -# Under development \ No newline at end of file +--- \ No newline at end of file diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 5535f2be..e9275068 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -24,7 +24,7 @@ const config = { docs: { sidebarPath: require.resolve('./sidebars.js'), // Please change this to your repo. - editUrl: 'https://github.com/sumeshir26/TimerX', + editUrl: 'https://github.com/sumeshir26/TimerX/blob/master', }, blog: false, theme: { From 3d19ebed823635a66969e53d85cc9027e2763a63 Mon Sep 17 00:00:00 2001 From: nef <83908932+not-nef@users.noreply.github.com> Date: Sun, 9 Jan 2022 16:09:44 +0100 Subject: [PATCH 02/13] Better PR instructions --- docs/docs/CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/CONTRIBUTING.md b/docs/docs/CONTRIBUTING.md index 425522c9..09b45ec1 100644 --- a/docs/docs/CONTRIBUTING.md +++ b/docs/docs/CONTRIBUTING.md @@ -17,7 +17,7 @@ python3 -m pip install -r requirements.txt python3 -m pip install -r windows-requirements.txt ``` After following the series of commands, open your favourite text editor. We recommend that you use [Visual Studio Code](https://code.visualstudio.com). Make your changes and before committing, go to the status bar. There will be a place showing branches and the text `master`. Click that, click `New branch` and name your branch, such as `patch-1` or so. Make sure it correlates to your feature, if it's a patch, name it as a patch, if it's a feature, name the feature. Next, go to the Version Control tab from the sidebar and commit the file, _semantically_. We recommend you to use semantic commits since that is more concise. -Commit your changes to that new branch, [open a pull request](https://github.com/sumeshir26/TimerX/pulls) and someone will review it ASAP. +Commit your changes to that new branch, [open a pull request](https://github.com/sumeshir26/TimerX/compare) (click `Compare across forks`) and someone will review it ASAP. ### Gitpod - Ready to code We support Gitpod - a ready-to-code environment customised for TimerX. You could either customise the app or the TimerX website. To code on Gitpod, follow the steps below: @@ -42,4 +42,4 @@ It will ask you what type of change it is, the scope(just hit enter) and the com ```shell git push ``` -After that, you can open a PR [here](https://github.com/sumeshir26/TimerX/pulls/new). Choose your branch and open it and a reviewer will review it soon. \ No newline at end of file +After that, you can open a PR [here](https://github.com/sumeshir26/TimerX/pulls/new). Choose your branch and open it and a reviewer will review it soon. From 349fcf2fe2a20f6c80b804fad526fdea0b894aab Mon Sep 17 00:00:00 2001 From: LG Date: Mon, 10 Jan 2022 03:27:04 +0000 Subject: [PATCH 03/13] docs(landing-page): Add text, YAML front matter I need some text, any ideas? No breaking changes. --- docs/docs/intro.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index ef0119d4..b415907c 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -1,3 +1,6 @@ --- sidebar_position: 1 ---- \ No newline at end of file +slug: intro +title: Welcome to TimerX Docs +--- +# Welcome to TimerX Docs From f1a0b314fa5f506b98e9261641f73b65d40270b3 Mon Sep 17 00:00:00 2001 From: LG Date: Mon, 10 Jan 2022 03:51:45 +0000 Subject: [PATCH 04/13] docs(compile-guide): Update compiling guide Need to add some extra things, I need to switch workspaces. --- docs/docs/Compiling TimerX from source.md | 8 ---- docs/docs/compile.md | 45 +++++++++++++++++++++++ docs/docusaurus.config.js | 2 +- 3 files changed, 46 insertions(+), 9 deletions(-) delete mode 100644 docs/docs/Compiling TimerX from source.md create mode 100644 docs/docs/compile.md diff --git a/docs/docs/Compiling TimerX from source.md b/docs/docs/Compiling TimerX from source.md deleted file mode 100644 index 1828aa33..00000000 --- a/docs/docs/Compiling TimerX from source.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Compiling TimerX from source -Before compiling, make soure you have [Python 3.x](https://python.org/downloads/ and optionally [Git](https://git-scm.org) installed; we recommend you to use Python 3.10 for compiling TimerX. -## Step 1 -Open your terminal and head to the TimerX folder; if you have Git, clone it with `git clone https://github.com/sumeshir26/TimerX.git` or download the ZIP \ No newline at end of file diff --git a/docs/docs/compile.md b/docs/docs/compile.md new file mode 100644 index 00000000..9708b607 --- /dev/null +++ b/docs/docs/compile.md @@ -0,0 +1,45 @@ +--- +sidebar_position: 3 +slug: compile +title: Compiling TimerX +--- + +# Compiling TimerX from source +Before compiling, make soure you have [Python 3.x](https://python.org/downloads/) with PIP and optionally [Git](https://git-scm.org) installed; we recommend you to use Python 3.10 for compiling TimerX. + +Make sure Python is added to your PATH while installing. +## Step 1 {#repoclone} +Open your terminal and head to the TimerX folder; if you have Git, clone it with `git clone https://github.com/sumeshir26/TimerX.git` or download the ZIP file from [here](https://github.com/sumeshir26/TimerX/archive/refs/heads/master.zip). +## Step 2 {#packages} +After going inside your directory, make sure that you install the required packages via `pip3` or `pip` if you use Anaconda3: +```console +$ pip3 install -r requirements.txt +$ pip3 install -r packager-requirements.txt +OR, if you use Anaconda3, +$ pip install -r requirements.txt +$ pip install -r packager-requirements.txt +``` +If you are on Windows, you can install the Windows requirements file by: +```batch +pip3 install -r windows-requirements.txt +REM or if you use Anaconda3, +pip install -r windows-requirements.txt +``` + +## Step 3 {#compile} +After you install the required packages, execute these commands in TimerX's root directory: +### Windows compiling +```batch +REM for making a n unzipped executable package +python3 setup.py bdist_win +REM for making an installer: +python3 setup.py bdist_msi +``` +If you use Anaconda3: +```batch +REM if you want the unzipped package +python setup.py bdist_win +REM if you need an installer: +python setup.py bdist_msi +``` + diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index e9275068..7469beb1 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -24,7 +24,7 @@ const config = { docs: { sidebarPath: require.resolve('./sidebars.js'), // Please change this to your repo. - editUrl: 'https://github.com/sumeshir26/TimerX/blob/master', + editUrl: 'https://github.com/sumeshir26/TimerX/blob/master/docs', }, blog: false, theme: { From c288b782bc91c75816b0e5ea37f35cdb5b0c13b9 Mon Sep 17 00:00:00 2001 From: LG Date: Mon, 10 Jan 2022 04:51:29 +0000 Subject: [PATCH 05/13] docs(compile-guide): Completed compile guide documentation Next, common issues? But anyway, :tada:! --- docs/docs/compile.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/docs/compile.md b/docs/docs/compile.md index 9708b607..bc81c40a 100644 --- a/docs/docs/compile.md +++ b/docs/docs/compile.md @@ -43,3 +43,33 @@ REM if you need an installer: python setup.py bdist_msi ``` +### macOS compiling +```shell +# Standalone app +python3 setup.py bdist_mac +# Installer +python3 setup.py bdist_dmg +``` +If you use Anaconda3: +```shell +# Standalone app +python setup.py bdist_mac +# Installer +python setup.py bdist_dmg +``` +### Linux +You can generate only a DEB or RPM installer for Linux. +For Debian-based distros: +```shell +# If on Anaconda3, use `python setup.py bdist_rpm` +python3 setup.py bdist_rpm +cd dist +sudo apt install alien +sudo alien -d TimerX-*.tar.gz --version=1.0 +``` +For RHEL-based distros: +```shell +python3 setup.py bdist_rpm +# Anaconda3 +python setup.py bdist_rpm +``` \ No newline at end of file From 213f7b3c2173994163588e1fad69c999b248cb8d Mon Sep 17 00:00:00 2001 From: LG <76845820+im-coder-lg@users.noreply.github.com> Date: Mon, 10 Jan 2022 15:24:43 +0530 Subject: [PATCH 06/13] Update docs/docs/compile.md Co-authored-by: sumeshir26 <68823982+sumeshir26@users.noreply.github.com> --- docs/docs/compile.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/compile.md b/docs/docs/compile.md index bc81c40a..91dbf0e8 100644 --- a/docs/docs/compile.md +++ b/docs/docs/compile.md @@ -38,7 +38,7 @@ python3 setup.py bdist_msi If you use Anaconda3: ```batch REM if you want the unzipped package -python setup.py bdist_win +python setup.py bdist_exe REM if you need an installer: python setup.py bdist_msi ``` From 2996a6273000514c74cf0cc51f974a80cbd41392 Mon Sep 17 00:00:00 2001 From: LG <76845820+im-coder-lg@users.noreply.github.com> Date: Mon, 10 Jan 2022 16:31:47 +0530 Subject: [PATCH 07/13] docs: Update compile.md --- docs/docs/compile.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/compile.md b/docs/docs/compile.md index 91dbf0e8..dedef1e9 100644 --- a/docs/docs/compile.md +++ b/docs/docs/compile.md @@ -30,7 +30,7 @@ pip install -r windows-requirements.txt After you install the required packages, execute these commands in TimerX's root directory: ### Windows compiling ```batch -REM for making a n unzipped executable package +REM for making an unzipped executable package python3 setup.py bdist_win REM for making an installer: python3 setup.py bdist_msi @@ -72,4 +72,4 @@ For RHEL-based distros: python3 setup.py bdist_rpm # Anaconda3 python setup.py bdist_rpm -``` \ No newline at end of file +``` From 1a2c6be03a7b258b57d3324634f56a0231bcad02 Mon Sep 17 00:00:00 2001 From: LG <76845820+im-coder-lg@users.noreply.github.com> Date: Mon, 10 Jan 2022 19:45:58 +0530 Subject: [PATCH 08/13] docs: Update footer --- docs/docusaurus.config.js | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 7469beb1..d4155b09 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -63,9 +63,17 @@ const config = { title: 'Docs', items: [ { - label: 'Under work', + label: 'Documentation', to: '/docs/intro', }, + { + label: 'Contributing to TimerX', + to: '/docs/contributing', + }, + { + label: 'Compiling from source', + to: '/docs/compiling', + }, ], }, From a875332a2f928fee675924f966aca62fae4dc052 Mon Sep 17 00:00:00 2001 From: LG <76845820+im-coder-lg@users.noreply.github.com> Date: Mon, 10 Jan 2022 19:48:53 +0530 Subject: [PATCH 09/13] docs: Update config Yikes! --- docs/docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index d4155b09..3e51f77f 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -72,7 +72,7 @@ const config = { }, { label: 'Compiling from source', - to: '/docs/compiling', + to: '/docs/compile', }, ], }, From e40bd7d31de30077074ac6ed25968b4222a7cf0a Mon Sep 17 00:00:00 2001 From: LG <76845820+im-coder-lg@users.noreply.github.com> Date: Mon, 10 Jan 2022 20:43:29 +0530 Subject: [PATCH 10/13] docs: Add replit to contributing.md --- CONTRIBUTING.md | 25 ++++++++++++++++++++----- docs/docs/CONTRIBUTING.md | 7 +++++++ 2 files changed, 27 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index edfb5277..06ce695c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,15 @@ +--- +sidebar_position: 2 +id: contributing +title: Contributing to TimerX +--- + # Contributing to TimerX TimerX is written in **Python**, so you have to install it if you want to contribute. You can download the latest version from [here](https://www.python.org/downloads/). -Make sure to check `Add Python 3.10 to path` when installing it. -After installing Python, get [Git](https://git-scm.org). It's version control, so that will help you in adding your changes over here. +Make sure to check `Add Python 3.10 to PATH` when installing it. +After installing Python, install [Git](https://git-scm.org). It's version control, so that will help you in adding your changes over here. Click the `Fork` button on the top-right in the GitHub page. Give it a few seconds to fork TimerX and then execute these series of commands in your Terminal/Command Prompt. ```shell git clone https://github.com/your-username/TimerX && cd TimerX @@ -11,7 +17,7 @@ python3 -m pip install -r requirements.txt python3 -m pip install -r windows-requirements.txt ``` After following the series of commands, open your favourite text editor. We recommend that you use [Visual Studio Code](https://code.visualstudio.com). Make your changes and before committing, go to the status bar. There will be a place showing branches and the text `master`. Click that, click `New branch` and name your branch, such as `patch-1` or so. Make sure it correlates to your feature, if it's a patch, name it as a patch, if it's a feature, name the feature. Next, go to the Version Control tab from the sidebar and commit the file, _semantically_. We recommend you to use semantic commits since that is more concise. -Commit your changes to that new branch, [open a pull request](https://github.com/sumeshir26/TimerX/pulls) and someone will review it ASAP. +Commit your changes to that new branch, [open a pull request](https://github.com/sumeshir26/TimerX/compare) (click `Compare across forks`) and someone will review it ASAP. ### Gitpod - Ready to code We support Gitpod - a ready-to-code environment customised for TimerX. You could either customise the app or the TimerX website. To code on Gitpod, follow the steps below: @@ -25,7 +31,9 @@ The environment is building itself. You'll have to wait for at least 2 minutes, #### 4. Start coding! When Gitpod loads, you will be greeted by a VS Code UI. You could start coding immediately. But be wary - the commits are forced to be semantic. Fortunately, we have a CLI tool called `cz` that could help you on committing. #### Ready to commit? -First, create a new branch. Name it in a way that it tells your feature in a short, abstract way. After creating your branch, open a new terminal(Ctrl + `. The ` symbol is beside the number 1 key or right above the Tab key. Then, type these commands: +First, create a new branch. Name it in a way that it tells your feature in a short, abstract way. After creating your branch, open a new terminal by typing Ctrl + `. + +The ` symbol is beside the number 1 key or right above the Tab key. Then, type these commands: ```shell git add . # stages your code to commit. cz c # The tool for committing the code @@ -34,4 +42,11 @@ It will ask you what type of change it is, the scope(just hit enter) and the com ```shell git push ``` -After that, you can open a PR [here](https://github.com/sumeshir26/TimerX/pulls) and a reviewer will review it soon. +After that, you can open a PR [here](https://github.com/sumeshir26/TimerX/pulls/new). Choose your branch and open it and a reviewer will review it soon. + +### [Repl.it](https://repl.it) +Go to the Repl.it homepage and click `Create a repl`. On the top right corner, there is a `Import from GitHub` button. Click that and in the place of the URL, type `github.com/sumeshir26/TimerX`. Create the repl and go to it. + +The repl will be booted and ready to use. + +Happy coding 🚀 \ No newline at end of file diff --git a/docs/docs/CONTRIBUTING.md b/docs/docs/CONTRIBUTING.md index 09b45ec1..06ce695c 100644 --- a/docs/docs/CONTRIBUTING.md +++ b/docs/docs/CONTRIBUTING.md @@ -43,3 +43,10 @@ It will ask you what type of change it is, the scope(just hit enter) and the com git push ``` After that, you can open a PR [here](https://github.com/sumeshir26/TimerX/pulls/new). Choose your branch and open it and a reviewer will review it soon. + +### [Repl.it](https://repl.it) +Go to the Repl.it homepage and click `Create a repl`. On the top right corner, there is a `Import from GitHub` button. Click that and in the place of the URL, type `github.com/sumeshir26/TimerX`. Create the repl and go to it. + +The repl will be booted and ready to use. + +Happy coding 🚀 \ No newline at end of file From 2f0c031af8859b138f4873c2f8555ddbebbdd84d Mon Sep 17 00:00:00 2001 From: LG <76845820+im-coder-lg@users.noreply.github.com> Date: Tue, 11 Jan 2022 12:38:32 +0530 Subject: [PATCH 11/13] docs: Update requirement filename Adhering to the recent changes. --- docs/docs/compile.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/compile.md b/docs/docs/compile.md index dedef1e9..481adf76 100644 --- a/docs/docs/compile.md +++ b/docs/docs/compile.md @@ -14,10 +14,10 @@ Open your terminal and head to the TimerX folder; if you have Git, clone it with After going inside your directory, make sure that you install the required packages via `pip3` or `pip` if you use Anaconda3: ```console $ pip3 install -r requirements.txt -$ pip3 install -r packager-requirements.txt +$ pip3 install -r requirements-dev.txt OR, if you use Anaconda3, $ pip install -r requirements.txt -$ pip install -r packager-requirements.txt +$ pip install -r requirements-dev.txt ``` If you are on Windows, you can install the Windows requirements file by: ```batch From 64a6d6d7308c15bd695684676cf968e8f2fe2e90 Mon Sep 17 00:00:00 2001 From: LG <76845820+im-coder-lg@users.noreply.github.com> Date: Tue, 11 Jan 2022 12:55:03 +0530 Subject: [PATCH 12/13] ci: Rename task on Windows checks From pyinstaller to cx_Freeze --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 33c23035..2cc68bfc 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -22,7 +22,7 @@ jobs: - name: Install requirements run: | pip install -r packager-requirements.txt - - name: Run PyInstaller + - name: Run cx_Freeze run: | python setup.py bdist_msi From d103e2d1f64f35a3246a531f27ffbbcfa25869d7 Mon Sep 17 00:00:00 2001 From: LG <76845820+im-coder-lg@users.noreply.github.com> Date: Tue, 11 Jan 2022 13:32:20 +0530 Subject: [PATCH 13/13] ci: Fix Windows build error --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 0fc2a8d9..b7305c36 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -22,7 +22,7 @@ jobs: - name: Install requirements run: | - pip install -r packager-requirements.txt + pip install -r requirements-dev.txt - name: Run cx_Freeze run: |