diff --git a/docs/gsoc/index.yml b/docs/gsoc/index.yml deleted file mode 100644 index 50a8d7e9..00000000 --- a/docs/gsoc/index.yml +++ /dev/null @@ -1,2 +0,0 @@ -order: 0 -label: "GSoC" \ No newline at end of file diff --git a/docs/gsoc/guide.md b/docs/gsoc2024/guide.md similarity index 100% rename from docs/gsoc/guide.md rename to docs/gsoc2024/guide.md diff --git a/docs/gsoc/ideas.md b/docs/gsoc2024/ideas.md similarity index 100% rename from docs/gsoc/ideas.md rename to docs/gsoc2024/ideas.md diff --git a/docs/gsoc2024/index.yml b/docs/gsoc2024/index.yml new file mode 100644 index 00000000..5efae539 --- /dev/null +++ b/docs/gsoc2024/index.yml @@ -0,0 +1,2 @@ +order: -1 +label: "GSoC 2024" \ No newline at end of file diff --git a/docs/gsoc2025/guide.md b/docs/gsoc2025/guide.md new file mode 100644 index 00000000..08e6a0b6 --- /dev/null +++ b/docs/gsoc2025/guide.md @@ -0,0 +1,58 @@ +--- +icon: rocket +order: 10 +label: "Application Guide" +--- + +Before starting, please read the [Ideas](./ideas.md) page and choose a project you are interested in. +Set up a C11 compiler, clone pocketpy sources from github and try to build. +This helps you confirm that your skills and experience match the requirements of the project. + +### Build guide for beginners + +First, you need to install these tools: + +1. Python(>= 3.8), I am sure you already have it. +2. A C11 compiler, such as GCC, Clang or MSVC. If you are on Linux, `gcc` is already installed. If you are on Windows, you can install Visual Studio with C/C++ development tools. +3. CMake(>= 3.10), a cross-platform build tool. You can use `pip install cmake` to install it. + +Then, clone pocketpy sources from github and try to build: +```bash +git clone https://github.com/pocketpy/pocketpy +cd pocketpy + +python cmake_build.py +``` + +If everything goes well, you will get a `main` executable (`main.exe` on Windows) in the root directory of pocketpy. +Simply run it and you will enter pocketpy's REPL. +```txt +pocketpy 2.0.5 (Jan 17 2025, 14:36:15) [64 bit] on darwin +https://github.com/pocketpy/pocketpy +Type "exit()" to exit. +>>> +>>> "Hello, world" +'Hello, world' +``` + +### Application guide + +**Your need to send an email to `blueloveth@foxmail.com` with the following information:** + +1. A brief introduction about yourself, including the most related open sourced project you have worked on before. It is highly recommended to attach your Github profile link. +2. A technical proposal for the project you are interested in working on, including: + + Your understanding of the project. + + The technical approach/architecture you will adopt. + + The challenges you might face and how you will overcome them. +3. A timeline for the project, including the milestones and deliverables. +4. Other information required by the Google Summer of Code program. + +### Coding style guide + +See [Coding Style Guide](../coding_style_guide.md). + +### Contact us + +If you have any questions, you can join our [Discord](https://discord.gg/WWaq72GzXv) +or contact me via email. +We are glad to help you with your application. diff --git a/docs/gsoc2025/ideas.md b/docs/gsoc2025/ideas.md new file mode 100644 index 00000000..ea63a4b8 --- /dev/null +++ b/docs/gsoc2025/ideas.md @@ -0,0 +1,17 @@ +--- +icon: light-bulb +order: 0 +label: "Project Ideas" +--- + +### Porting LDTK importer for game scripting + ++ Difficulty Level: 2/5 (Easy) ++ Skill: Python ++ Project Length: Small + +### VSCode plugin for debugging pocketpy applications + ++ Difficulty Level: 4/5 (Hard) ++ Skill: C, TypeScript ++ Project Length: Medium diff --git a/docs/gsoc2025/index.yml b/docs/gsoc2025/index.yml new file mode 100644 index 00000000..bca6c439 --- /dev/null +++ b/docs/gsoc2025/index.yml @@ -0,0 +1,2 @@ +order: 0 +label: "GSoC 2025" \ No newline at end of file