bump version

charlesneimog · Nov 24, 2024 · 02cf141 · 02cf141
1 parent c370d4c
commit 02cf141
Show file tree

Hide file tree

Showing 9 changed files with 118 additions and 11 deletions.
diff --git a/Documentation/patch/problems/compilation.md b/Documentation/patch/problems/compilation.md
@@ -24,7 +24,7 @@ If you have problems to compile, the easiear way to solve is to report what is t
 -   :construction: __`pd4web` can not process some object__:
     -   __Solution:__ You must report the problem and the object. I probably never used this object.
 -   :construction: __Cmake configuration problems__:
-    -   __Solution:__ Try to delete the `Pd4Web`, `build` and `Webpatch`, then compile it again, on errors, report the issue.
+    -   __Solution:__ Try to delete the `Pd4Web`, `build` and `Webpatch`, then compile it again, on errors, report the issue. 
 </div>
 
 <div class="grid cards" markdown>

diff --git a/Documentation/patch/problems/flutex.md b/Documentation/patch/problems/flutex.md
@@ -5,11 +5,11 @@
   }
 </style>
 
+<h2 align="center"><code>flutex.c</code> problems</h2>
+
 !!! bug "How to report?"
     <p style="font-size: 18px">Create a new issue on [Github](https://github.com/charlesneimog/pd4web/issues) or use [Google Forms](https://forms.gle/qS7YX4QzrUKNXGkU7).</p>
 
-<h2 align="center"><code>flutex.c</code> problems</h2>
-
 If this happens, probably is because you are using some object that I don't use in my patches. So, you need to report this problem to me and I will try to solve this. 
 
 To report the problem you must share the patch that is causing the problem, without the patch is impossible to solve the problem. You can always reduce the patch to the minimum size that is causing the problem. 

diff --git a/Documentation/patch/problems/memory.md b/Documentation/patch/problems/memory.md
@@ -5,10 +5,11 @@
   }
 </style>
 
+<h2 align="center">Memory problems</h2>
+
 !!! bug "How to report?"
     <p style="font-size: 18px">Create a new issue on [Github](https://github.com/charlesneimog/pd4web/issues) or use [Google Forms](https://forms.gle/qS7YX4QzrUKNXGkU7).</p>
 
-<h2 align="center">Memory problems</h2>
 
 You need to define the size of memory of your patch, this is pretty simple. Big patches needs more memory, small patches needs less memory.
 

diff --git a/Documentation/patch/upload/cloudflare.md b/Documentation/patch/upload/cloudflare.md
@@ -0,0 +1,37 @@
+---
+hide:
+  - toc
+---
+ <style>
+  .md-typeset h1,
+  .md-content__button {
+    display: none;
+  }
+</style>
+
+### Upload files
+
+- Create a new account on [Cloudflare](https://dash.cloudflare.com/sign-up){target="_blank"}.
+
+---
+
+- After creating your account, go to this [link](https://dash.cloudflare.com/){target="_blank} and search for `Workers and Pages`, click on it.
+
+---
+
+- Click on the `Create` and then, in the `Pages` section, click on the `Upload assets` button.
+
+---
+
+- Select the project name, your website will be `<project-name>.pages.dev`. Then click on the `Create Project` button.
+
+---
+
+- Then, inside the `WebPatch` folder, select all files and create a zip file. After that, upload the zip file to the Cloudflare. 
+
+---
+
+### Publish your patch
+
+- Click on the `Deploy site` button and wait a few seconds (this can take 5 minutes). You will see a link to your patch. 
+
diff --git a/Documentation/patch/upload/github.md b/Documentation/patch/upload/github.md
@@ -0,0 +1,46 @@
+---
+hide:
+  - toc
+---
+ <style>
+  .md-typeset h1,
+  .md-content__button {
+    display: none;
+  }
+</style>
+
+### Upload files
+
+* To upload your patch on Github, first you need a Github account. If you don't have one, you can create it [here](https://github.com/signup){target="_blank"}. Be sure to use a good username, your website will be `<username>.github.io`. 
+
+--- 
+
+* After creating your account, you can create a new repository, you can use this [link](https://github.com/new){target="_blank"}. Be sure to use a good name for your repository, your patch will be available at `<username>.github.io/<repository-name>`. After all configuration, click on the `Create repository` button.
+
+---
+
+* After creating your repository, you will see a weird page with a lot of information. You can ignore all of this and search for the link `uploading an existing file`. Click on it.
+
+<p align="center">
+  <img src="../upload.png" alt="github-upload" width="100%" style="border-radius: 10px; box-shadow: 0 0 10px rgba(0, 0, 0, 0.3);">
+</p>
+
+---
+
+* After clicking on the link, you will see a page with a box to drag and drop your files. Upload all files inside the `Webpatch` folder. You can select all files and drag them to the box. After that, you can click on the `Commit changes` button.
+
+---
+<p align="center">
+  Wait a few seconds to see your files on the repository.
+</p>
+
+### Publish your patch
+
+* From your repository page, click on the `Settings` tab. After that, scroll down to the `Pages` section. On the section `Build and deployment`, select the branch `main` and the folder `/root`. After that, click on the `Save` button. 
+
+Wait a few seconds and you will see a link to your patch. You can access your patch using the link `<username>.github.io/<repository-name>`.
+
+!!! bug "Save button not working?"
+    Sometimes the `Save` button does not become available for the `/root`, change from `main` to `None` then `Save`, after that, change back to `main` and `Save` again.
+
+
diff --git a/Documentation/patch/upload/others.md b/Documentation/patch/upload/others.md
@@ -0,0 +1,19 @@
+---
+hide:
+  - toc
+---
+ <style>
+  .md-typeset h1,
+  .md-content__button {
+    display: none;
+  }
+</style>
+
+There is a lot of ways to upload your patch, you can use Github, Cloudflare, or even your own server. `Github` and `Cloudflare` are the easiest ways to do it in my opinion. Here some lists of options:
+
+- [Gitlab](https://about.gitlab.com/){target="_blank"}
+- [Bitbucket](https://bitbucket.org/){target="_blank"}
+- [Heroku](https://www.heroku.com/){target="_blank"}
+- [Netlify](https://www.netlify.com/){target="_blank"}
+- [Vercel](https://vercel.com/){target="_blank"}
+- [Surge](https://surge.sh/){target="_blank"}
diff --git a/Documentation/patch/upload/upload.png b/Documentation/patch/upload/upload.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -78,17 +78,21 @@ nav:
       - Compilation: 
         - patch/compile.md
       - Website Templates: 
-        - patch/Templates/index.md
+        - patch/templates/index.md
         - Website Templates List: 
-          - patch/Templates/1-score.md
-          - patch/Templates/2-hands.md
-          - patch/Templates/3-choir.md
-          - patch/Templates/4-p5js.md
-          - patch/Templates/5-tutorial.md
+          - patch/templates/1-score.md
+          - patch/templates/2-hands.md
+          - patch/templates/3-choir.md
+          - patch/templates/4-p5js.md
+          - patch/templates/5-tutorial.md
       - Problems: 
         - patch/problems/memory.md
         - patch/problems/compilation.md
         - patch/problems/flutex.md
+      - Uploading your patch: 
+        - patch/upload/github.md
+        - patch/upload/cloudflare.md
+        - patch/upload/others.md
   - libraries.md
   - Pd4Web JavaScript Module: 
     - JavaScript Module: js/js.md

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pd4web"
-version = "2.1.2"
+version = "2.2.0"
 description = "pd4web compiles PureData patches with external objects for Wasm, allowing to run entire patches in web browsers."
 authors = ["Charles K. Neimog <charlesneimog@outlook.com>"]
 readme = "README.md"