Difference between revisions of "Google Summer of Code 2017"

From KolibriOS wiki
Jump to navigation Jump to search
(Copy of GSoC'2016 page)
 
(2016 -> 2017, update links, add short list of new ideas, delete ideas I don't like)
Line 1: Line 1:
−
<!-- [[Image:GSoC2015.png|right]] -->
 
 
== Introduction ==
 
== Introduction ==
−
KolibriOS is going to apply as a mentoring organization for [https://developers.google.com/open-source/gsoc/ Google Summer of Code 2016]. This page contains our ideas list and some additional information for students and mentors.
+
KolibriOS is going to apply as a mentoring organization for [https://developers.google.com/open-source/gsoc/ Google Summer of Code 2017]. This page contains our ideas list and some additional information for students and mentors.
  
−
We have previously participated as a Mentoring Organization in [http://www.google-melange.com/gsoc/homepage/google/gsoc2014 Google Summer of Code 2014]. The [[Google Summer of Code 2014|ideas page for 2014]] is available for your reference. Our organization page for GSoC 2014 and successfully completed projects for that year can be accessed [https://www.google-melange.com/gsoc/org2/google/gsoc2014/kolibrios via this link]. To our great delight, both successful students of GSoC2014 stayed with the project and continue contributing to KolibriOS voluntarily in their spare time.
+
Why we participate? Goals?
  
−
In 2013, we have run an [[KolibriOS Summer of Code 2013|independent Summer of Code]] using money we [http://www.kickstarter.com/projects/kolibrios/kolibrios-help-us-hold-our-own-summer-of-code-2013 collected with Kickstarter]. Two students have worked on KolibriOS, and the results of 2013 Summer of Code were: adding write support for EXT2 filesystem, and adding (read-only) support for XFS filesystem.
+
Why this application is distinct?
 +
 
 +
We have previously successfully participated as a Mentoring Organization in Google Summer of Code in 2014 and 2016. Historical links to these events are available for your reference:
 +
 
 +
*2014: [[Google Summer of Code 2014|Ideas page]], [https://www.google-melange.com/archive/gsoc/2014/orgs/kolibrios organization and accepted projects]
 +
*2016: [[Google Summer of Code 2016|Ideas page]], [https://summerofcode.withgoogle.com/archive/2016/organizations/5678701068943360/ organization and accepted projects]
 +
<br>
 +
We are optimistic and therefore always discovering oportunities for further development of KolibriOS. In 2013, we have run an [[KolibriOS Summer of Code 2013|independent Summer of Code]] using money we [http://www.kickstarter.com/projects/kolibrios/kolibrios-help-us-hold-our-own-summer-of-code-2013 collected with Kickstarter]. Two students have worked on KolibriOS, and the results of 2013 Summer of Code were: adding write support for EXT2 filesystem, and adding (read-only) support for XFS filesystem.
 +
 
 +
To our great delight, most successful students of GSoC stayed with the project and continue contributing to KolibriOS voluntarily in their spare time.
  
 
== Student Requirements ==
 
== Student Requirements ==
−
Prospective students are required to register [http://board.kolibrios.org/ on our developers forum], register [http://board.kolibrios.org/viewtopic.php?f=7&t=3240 yourself as a student], join the [http://board.kolibrios.org/chat.php developers chat] and submit a small bugfix / improvement [[Get_source_code|to our SVN]] in order for their application to be considered. Examples of such tasks can be obtained by asking on developers chat or on our IRC channel (#kolibrios @ irc.freenode.net). This requirement is only to show us that you are able to work with [[Get_source_code|our SVN]] and interact with our developers if you are selected. '''This task has to be completed before  [https://developers.google.com/open-source/gsoc/timeline student application deadline] (25 March 19:00 UTC).'''<br><br>
+
Prospective students are required to register [http://board.kolibrios.org/ on our developers forum], register [http://board.kolibrios.org/viewtopic.php?f=7&t=3240 yourself as a student], join the [http://board.kolibrios.org/chat.php developers chat] and submit a small bugfix / improvement [[Get_source_code|to our SVN]] in order for their application to be considered. Examples of such tasks can be obtained by asking on developers chat or on our IRC channel (#kolibrios @ irc.freenode.net). This requirement is only to show us that you are able to work with [[Get_source_code|our SVN]] and interact with our developers if you are selected. '''This task has to be completed before  [https://developers.google.com/open-source/gsoc/timeline student application deadline] (03 April 16:00 UTC).'''<br><br>
 
In addition, students need to answer the following questions when applying:
 
In addition, students need to answer the following questions when applying:
 
# Full Name (First + Last Name).
 
# Full Name (First + Last Name).
Line 23: Line 31:
 
# Have you been involved with any open-source project in the past? If yes, which one, and what have you done for that project?
 
# Have you been involved with any open-source project in the past? If yes, which one, and what have you done for that project?
 
# Code samples - please provide links to code that you have written. It can be your high school project, contribution to open-source organization, your college/university task or anything like that.
 
# Code samples - please provide links to code that you have written. It can be your high school project, contribution to open-source organization, your college/university task or anything like that.
−
# The task you are willing to work on from our list of Summer of Code 2016 ideas (or suggest your own idea, if you don't like any of the proposed ideas). Please provide an approximate work plan for your task split to 1-week intervals, as well as expected outcome of your work. '''This point should be detailed as much as possible, as your application would be evaluated mainly based on what you write here.''' You are welcome (and even encouraged!) to collaborate with potential mentors on this paragraph.
+
# The task you are willing to work on from our list of Summer of Code 2017 ideas (or suggest your own idea, if you don't like any of the proposed ideas). Please provide an approximate work plan for your task split to 1-week intervals, as well as expected outcome of your work. '''This point should be detailed as much as possible, as your application would be evaluated mainly based on what you write here.''' You are welcome (and even encouraged!) to collaborate with potential mentors on this paragraph.
 
# What other time commitments, such as school work, university studies, another job, planned vacation, etc., will you have between May 23 and August 23 (coding period)? Please be as specific as possible. ''Bear in mind that GSoC is like a full-time job, so if you consider taking a summer semester at the university (with more than 1-2 courses), or intend to perform an internship or work elsewhere during the summer in addition to GSoC, you will likely be '''NOT''' accepted.''
 
# What other time commitments, such as school work, university studies, another job, planned vacation, etc., will you have between May 23 and August 23 (coding period)? Please be as specific as possible. ''Bear in mind that GSoC is like a full-time job, so if you consider taking a summer semester at the university (with more than 1-2 courses), or intend to perform an internship or work elsewhere during the summer in addition to GSoC, you will likely be '''NOT''' accepted.''
  
Line 51: Line 59:
 
|Mentor
 
|Mentor
 
|-
 
|-
−
|Sergey Kuzmin
+
|Ivan Baravy
−
|[[User:Wildwest|Wildwest]]
+
|[[User:dunkaist|dunkaist]]
 
|Mentor
 
|Mentor
 
|-
 
|-
 
|}
 
|}
−
We have discussed "Google Summer of Code 2016" application with all active members of the KolibriOS Project Team, and selected only those 3 (three) people who have both the knowledge, the dedication, and the time to help their students during the entire summer. Each one of them was assigned to mentor projects in his area of specialization only. In a rare event when a Mentor from the above list cannot continue mentoring his student(s) due to personal circumstances, we will try to find a replacement Mentor, or ask the remaining Mentors to cover for the missing one. Additionally, there is always a number of knowledgeable members of our team hanging around our [http://board.kolibrios.org/chat.php forum chat], and they will gladly answer any student questions that may arise, even if they haven't volunteered as Mentors themselves.
+
We have discussed "Google Summer of Code 2017" application with all active members of the KolibriOS Project Team, and selected only those 3 (three) people who have both the knowledge, the dedication, and the time to help their students during the entire summer. Each one of them was assigned to mentor projects in his area of specialization only. In a rare event when a Mentor from the above list cannot continue mentoring his student(s) due to personal circumstances, we will try to find a replacement Mentor, or ask the remaining Mentors to cover for the missing one. Additionally, there is always a number of knowledgeable members of our team hanging around our [http://board.kolibrios.org/chat.php forum chat], and they will gladly answer any student questions that may arise, even if they haven't volunteered as Mentors themselves.
  
−
Most Mentors selected for this year are the same that were originally proposed for last year, and they have already proved to be responsible, helpful and knowledgeable during GSoC2014.
+
Most Mentors selected for this year are the same that were originally proposed for last year, and they have already proved to be responsible, helpful and knowledgeable during GSoC'2014 and GSoC'2016.
  
−
== Ideas for Google Summer of Code 2016 ==
+
== Ideas for Google Summer of Code 2017 ==
 
The below list contains ideas suggested by KolibriOS team members. '''It is neither complete nor final.'''<br>
 
The below list contains ideas suggested by KolibriOS team members. '''It is neither complete nor final.'''<br>
 
Students are welcome ('''and even encouraged''') to suggest their own ideas for GSoC, provided they can find a mentor amongst KolibriOS developers to guide them.
 
Students are welcome ('''and even encouraged''') to suggest their own ideas for GSoC, provided they can find a mentor amongst KolibriOS developers to guide them.
 +
 +
fuse driver + example, fasmg app and macros, tiny unicode library (NFC, NFD, sort, etc), AML interpreter, document viewer (zathura-like api), virt-io drivers, midi synthesizer and player, kolibri gui for fasmw text editor (has undo, supported by Tomasz Grysztar!), kfar plugin for tar, loop device driver (for iso, img, raw images, will help in partition manager development), squashfs, GIMP plugin for skin open/save (in C, Python or Scheme), brotli k(er)pack and kernel compression (+library), unit test framework (for kernel and libraries), OpenStreetMap client app,
 +
 +
Add info of benefits for students (per task).
  
 
=== Sortable list of ideas for easy navigation ===
 
=== Sortable list of ideas for easy navigation ===
Line 80: Line 92:
 
| Assembler(FASM)
 
| Assembler(FASM)
 
| Pathoswithin
 
| Pathoswithin
−
|-
 
−
| [[#CPUID_tool|CPUID tool]]
 
−
| Application
 
−
| Beginner
 
−
| Low
 
−
| Assembler(FASM)
 
−
| Wildwest
 
−
|-
 
−
| [[#FTP_client|FTP client]]
 
−
| Application
 
−
| Basic
 
−
| Medium
 
−
| Assembler(FASM)
 
−
| hidnplayr
 
−
|-
 
−
| [[#Torrent_client|Torrent client]]
 
−
| Application
 
−
| Advanced
 
−
| High
 
−
| Assembler(FASM)/C/C++
 
−
| hidnplayr
 
 
|-
 
|-
 
| [[#XMPP.2FJabber_client|XMPP/Jabber client]]
 
| [[#XMPP.2FJabber_client|XMPP/Jabber client]]
Line 115: Line 106:
 
| Assembler(FASM)/C/C++
 
| Assembler(FASM)/C/C++
 
| hidnplayr
 
| hidnplayr
−
|-
 
−
| [[#Web_browser|Web browser]]
 
−
| Application
 
−
| Intermediate
 
−
| High
 
−
| [http://www.dev0.de/cmm/indexe.htm Sphinx C--]
 
−
| Leency
 
 
|-
 
|-
 
| [[#Ethernet_driver.28s.29|Ethernet driver(s)]]
 
| [[#Ethernet_driver.28s.29|Ethernet driver(s)]]
Line 129: Line 113:
 
| Assembler(FASM)
 
| Assembler(FASM)
 
| hidnplayr
 
| hidnplayr
−
|-
 
−
| [[#SD_Host_Controller|SD Host Controller driver]]
 
−
| Driver
 
−
| Advanced
 
−
| Low
 
−
| Assembler(FASM)
 
−
| Pathoswithin
 
 
|-
 
|-
 
| [[#USB_devices|USB device drivers]]
 
| [[#USB_devices|USB device drivers]]
−
| Driver
 
−
| Expert
 
−
| High
 
−
| Assembler(FASM)
 
−
| hidnplayr
 
−
|-
 
−
| [[#Filesystem_support|Filesystem support]]
 
−
| Driver
 
−
| Expert
 
−
| High
 
−
| Assembler(FASM)
 
−
| Pathoswithin
 
−
|-
 
−
| [[#Wi-Fi|Wi-Fi]]
 
 
| Driver
 
| Driver
 
| Expert
 
| Expert
Line 165: Line 128:
 
| Pathoswithin
 
| Pathoswithin
 
|-
 
|-
−
| [[#QR-code_in_boot_log|QR-code in boot log]]
 
−
| Kernel/Library
 
−
| Basic
 
−
| Low
 
−
| Assembler(FASM)
 
−
| Pathoswithin
 
−
|-
 
−
| [[#C layer for KolibriOS|C layer for KolibriOS]]
 
−
| Library
 
−
| Intermediate / Advanced
 
−
| Medium / High
 
−
| C
 
−
| Ashmew2
 
−
|-
 
−
| [[#Virtualbox / QEMU support for KolibriOS|Virtualbox support for KolibriOS]]
 
−
| Library
 
−
| Advanced
 
−
| Medium
 
−
| C
 
−
| Ashmew2
 
−
|-
 
−
| [[#Port PolarSSL|Port PolarSSL]]
 
−
| Library
 
−
| Intermediate / Advanced
 
−
| High
 
−
| C / FASM
 
−
| hidnplayr / ashmew2
 
 
|-
 
|-
 
| [[#Port ScummVM|Port ScummVM]]
 
| [[#Port ScummVM|Port ScummVM]]
Line 227: Line 163:
 
* Mentor: Pathoswithin
 
* Mentor: Pathoswithin
 
* Links: [http://tibleiz.net/asm-xml/ fasm xml library], [https://en.wikipedia.org/wiki/XDXF XDXF format]
 
* Links: [http://tibleiz.net/asm-xml/ fasm xml library], [https://en.wikipedia.org/wiki/XDXF XDXF format]
−
 
−
 
−
==== CPUID tool ====
 
−
'''Summary:''' Update existing CPUID application to be aware of new CPUs and their features
 
−
 
−
'''Details:'''
 
−
* Primary goal: Write code to detect and report new CPUs and features + size detection for caches
 
−
* Additional goal: Refactor code as to use system libraries (libimg, box_lib, etc.)
 
−
* Language: Assembler/FASM
 
−
* Skill level: beginner/intermediate
 
−
* Importance: low
 
−
* Mentor: Wildwest
 
−
* Links: [http://websvn.kolibrios.org/listing.php?repname=Kolibri+OS&path=%2Fprograms%2Fsystem%2Fcpuid%2Ftrunk%2F&#aec5d374b78ae8f08110b3327c3ba5f56 CPUID program], [http://bochs.sourceforge.net/techspec/24161821.pdf Intel cpuid], [http://support.amd.com/TechDocs/25481.pdf AMD cpuid], [http://board.kolibrios.org/viewtopic.php?f=42&t=594&start=90 forum topic about application]
 
−
 
−
==== FTP client ====
 
−
'''Summary:''' Create a GUI based FTP client or add FTP support to one of the existing file managers
 
−
 
−
'''Details:'''
 
−
* Primary goal: FTP access (download/upload/etc.)
 
−
* Additional goal: Create an FTP client library
 
−
* Language: Assembler/FASM
 
−
* Skill level: beginner/intermediate
 
−
* Importance: High
 
−
* Mentor: hidnplayr
 
−
* Links: [https://www.ietf.org/rfc/rfc959.txt File Transfer Protocol (RFC959)], [http://board.kolibrios.org/viewtopic.php?f=40&t=2360 CLI FTP client (demo)]
 
−
 
−
 
−
==== Torrent client ====
 
−
'''Summary:''' Write a (bit-)torrent client for KolibriOS, or port an existing one
 
−
 
−
'''Details:'''
 
−
* Primary goal: Implement a torrent client similar to [http://www.utorrent.com/ µTorrent Free edition]
 
−
* Alternative goal (less preferred, but still possible): Port an existing torrent client to KolibriOS
 
−
* Language: Assembler/FASM
 
−
* Skill level: intermediate/advanced
 
−
* Importance: High
 
−
* Mentor: hidnplayr
 
−
* Links: [http://www.bittorrent.org Information about the protocol]
 
  
  
Line 301: Line 199:
 
* Skill level: intermediate/advanced
 
* Skill level: intermediate/advanced
 
* Importance: High
 
* Importance: High
−
* Mentors: hidnplayr
+
* Mentors: hidnplayr / dunkaist
 
* Links: [http://board.kolibrios.org/viewtopic.php?f=38&t=1596 AC97SND (MP3 player in C)], [http://board.kolibrios.org/viewtopic.php?f=28&t=317 Sound drivers and architecture], [http://board.kolibrios.org/viewtopic.php?f=38&t=3003 Flac decoder],[http://board.kolibrios.org/viewtopic.php?f=38&t=2220 Minimp3 (minimalistic mp3 decoding library)], [http://board.kolibrios.org/viewtopic.php?f=38&t=161 SuperMP3 (IDv3 tag demo)]
 
* Links: [http://board.kolibrios.org/viewtopic.php?f=38&t=1596 AC97SND (MP3 player in C)], [http://board.kolibrios.org/viewtopic.php?f=28&t=317 Sound drivers and architecture], [http://board.kolibrios.org/viewtopic.php?f=38&t=3003 Flac decoder],[http://board.kolibrios.org/viewtopic.php?f=38&t=2220 Minimp3 (minimalistic mp3 decoding library)], [http://board.kolibrios.org/viewtopic.php?f=38&t=161 SuperMP3 (IDv3 tag demo)]
  
−
 
−
==== Web browser ====
 
−
'''Summary:''' Improve existing text-only web browser Aelia (ex WebView) - add more functionality and compatibility
 
−
 
−
'''Details:'''
 
−
* Primary goal: Have mostly complete HTML4 support on a good enough level to read non-complex (mobile?) websites
 
−
* Secondary goal: Add certain elements of CSS, speed optimizations
 
−
* Language: [http://www.dev0.de/cmm/indexe.htm Sphinx C--]. May require writing a few lines in FASM though
 
−
* Skill level: intermediate/advanced
 
−
* Importance: High
 
−
* Mentors: Leency
 
−
'''Links:'''
 
−
* [http://www.w3.org/TR/REC-html40/ HTML 4.01 Specification]
 
−
* [http://board.kolibrios.org/viewtopic.php?f=40&t=1075 Work done so far on WebView (mostly in Russian)]. If you don't know Russian, you can read [http://translate.google.com/translate?hl=en&sl=ru&tl=en&u=http%3A%2F%2Fboard.kolibrios.org%2Fviewtopic.php%3Ff%3D40%26t%3D1075 English translation using Google-Translate]
 
  
 
==== Port ScummVM ====
 
==== Port ScummVM ====
Line 348: Line 232:
 
* Links: [https://www.broadcom.com/collateral/pg/57XX-PG105-R.pdf BCM57xx programmers guide], [[Writing network drivers for KolibriOS]], [https://github.com/UDOOboard/U-Boot_Unico/blob/master/drivers/net/bcm570x.c BCM570x driver for u-boot (in C)], [http://websvn.kolibrios.org/filedetails.php?repname=Kolibri+OS&path=%2Fdrivers%2Funfinished%2Fbcm57xx.asm Stub for BCM57xx driver]
 
* Links: [https://www.broadcom.com/collateral/pg/57XX-PG105-R.pdf BCM57xx programmers guide], [[Writing network drivers for KolibriOS]], [https://github.com/UDOOboard/U-Boot_Unico/blob/master/drivers/net/bcm570x.c BCM570x driver for u-boot (in C)], [http://websvn.kolibrios.org/filedetails.php?repname=Kolibri+OS&path=%2Fdrivers%2Funfinished%2Fbcm57xx.asm Stub for BCM57xx driver]
  
−
 
−
==== SD Host Controller ====
 
−
'''Summary:''' Add support for SD Host Controller
 
−
 
−
'''Details:'''
 
−
* Primary goal: Write driver for particular controller
 
−
* Additional goal: Test and update driver to work for all controllers
 
−
* Language: Assembler/FASM
 
−
* Skill level: intermediate/advanced
 
−
* Importance: Low
 
−
* Mentor: Pathoswithin
 
−
* Links: [https://www.sdcard.org/downloads/pls/simplified_specs/index.html SD specifications]
 
  
 
==== USB devices ====
 
==== USB devices ====
Line 372: Line 244:
 
* Mentor: hidnplayr
 
* Mentor: hidnplayr
 
* Links: [http://en.wikipedia.org/wiki/USB#Device_classes USB device classes]
 
* Links: [http://en.wikipedia.org/wiki/USB#Device_classes USB device classes]
−
 
−
 
−
==== Filesystem support ====
 
−
'''Summary:''' Improve filesystem support in KolibriOS
 
−
 
−
'''Details:'''
 
−
* Primary goal: Update/fix read-write support for ext2/3/4 filesystems (partially done)
 
−
* Additional goal: Any improvement of filesystem support in KolibriOS
 
−
* Language: Assembler/FASM
 
−
* Skill level: intermediate/advanced
 
−
* Importance: High
 
−
* Mentor: Pathoswithin
 
−
* Links: [http://websvn.kolibrios.org/listing.php?repname=Kolibri+OS&path=%2Fkernel%2Ftrunk%2Ffs%2F&#a0aa5cede7308db82d4bae78266ed8462 Filesystems in KolibriOS]
 
−
 
−
 
−
==== Wi-Fi ====
 
−
'''Summary:'''  Add Wi-Fi support to KolibriOS.
 
−
 
−
'''Details:'''
 
−
* Description: Write or port a Wi-Fi driver for KolibriOS, implement the ability to set a wireless connection.
 
−
* Language: Assembler/FASM
 
−
* Skill level: Expert
 
−
* Importance: High
 
−
* Mentor: hidnplayr
 
−
* Links: [https://en.wikipedia.org/wiki/Comparison_of_open-source_wireless_drivers Comparison of open source wifi drivers]
 
  
  
Line 415: Line 262:
 
* Links: [http://en.wikipedia.org/wiki/Widget_toolkit basic idea], [http://en.wikipedia.org/wiki/List_of_widget_toolkits list of toolkits]
 
* Links: [http://en.wikipedia.org/wiki/Widget_toolkit basic idea], [http://en.wikipedia.org/wiki/List_of_widget_toolkits list of toolkits]
  
−
 
−
==== QR-code in boot log ====
 
−
'''Summary:''' Add a [http://en.wikipedia.org/wiki/QR_code QR-code] (containing the debug log) at the end of boot process
 
−
 
−
[[File:QR-code.png]]
 
−
 
−
'''Details:'''
 
−
* Description: Sometimes KolibriOS cannot boot on a certain hardware configuration (gets stuck during or after boot process). In such cases, we request the user having this problem to enable debug log at boot time, take a photo of the screen and show it to us (in the forum). However, sometimes taking a good quality photo can be quite challenging (bad camera, shaking hands etc.) and the attached photo is so blurry to the point the debug log cannot be even read. The idea suggested hereby is to simultaneously encode the debug log which is outputted on the screen, to the form of QR-code, and show the resulting QR-code on empty space on the screen. In such way, any user possessing a smartphone with a camera and QR-code scanner, could scan the QR-code and submit the encoded text directly on our forums (without having a need to take a photo), and our developers, in turn, would get the debug log text immediately and won't have to unscramble a blurry photo.
 
−
* Language: Assembler/FASM
 
−
* Skill level: beginner/intermediate
 
−
* Mentor: Pathoswithin
 
−
 
−
 
−
==== C layer for KolibriOS ====
 
−
'''Summary:''' Building a C layer for KolibriOS, so that we can get more developers and port more code to KolibriOS more easily.
 
−
 
−
'''Details:'''
 
−
* Description: As a lot of software out there is available in C and useful for KolibriOS, building an ecosystem around C and FASM is required. Some work towards a cross compiler has already been done. Since KolibriOS is neither Linux, nor Windows..it is challenging to port software. In order to automate this, we need to port existing libraries and figure out a way to automate/streamline this process. The best part about this is that you get to mix C and FASM in unprecedented ways and learn along the way. The end result should be as easy as writing a Makefile and calling the cross compiler which creates a binary for Kolibri OS. The eventual aim is to have libraries in C available for KolibriOS which let you use the same ASM procedures in C code. Some work on this has already been done. Get in touch to know more!
 
−
Example:
 
−
    #include<kolibri.h>
 
−
    int main()
 
−
    {
 
−
    kolibri_window("Hi!");
 
−
    return 0;
 
−
    }
 
−
* Language(s):
 
−
:* C - Required
 
−
:* FASM <Not a strict requirement, but is desirable>
 
−
:* GNU Autotools (Easy to pick up, safe to assume optional).
 
−
* Skill level: intermediate, bonus points for the ability in designing a clean approach to achieve this.
 
−
* Mentor: ashmew2
 
−
* Additional details: This project relies on working with the mentor on completing this project as it might be too large to be finished by a single student over one summer. The mentor will also actively work on the same project with the student.
 
−
 
−
 
−
==== Virtualbox / QEMU support for KolibriOS ====
 
−
'''Summary:''' Building Virtualbox / QEMU support for KolibriOS so that it is easier to use in a virtual machine.
 
−
 
−
'''Details:'''
 
−
* Description: Create a set of tools which let KolibriOS seamlessly interface with a host running Kolibri via VirtualBox. Develop parts required, especially shared folders, which resemble Guest Additions. (For a Linux based Host running KolibriOS as Guest.)
 
−
If not virtualbox, QEMU could use some feature enhancements for example the ability to update a usb drive from outside Kolibri and make Kolibri understand the new contents of the usb drive. This requires investigation skills as well as working in both Kolibri for support and QEMU / Virtualbox source code (as and when required).
 
−
 
−
* Language(s):
 
−
:* C - Virtualbox Source code
 
−
:* FASM - To understand the source code of KolibriOS better and prepare interfaces with Guest additions.
 
−
* Skill level: Advanced [ Unknown ], ability to understand a larger source code base and contribute to it are very desirable!
 
−
* Mentor: ashmew2
 
−
 
−
==== Port PolarSSL ====
 
−
'''Summary:''' Port PolarSSL to KolibriOS.
 
−
'''Details:'''
 
−
* Primary goal: Make a working port of PolarSSL (as native KolibriOS MS COFF library) and add it to the automatic build-system.
 
−
* Additional goal: Update HTTP library (written in FASM) to support HTTPS.
 
−
* Language: C / FASM
 
−
* Skill level: intermediate / advanced
 
−
* Importance: High
 
−
* Mentors: hidnplayr / ashmew2
 
−
* Links: [http://board.kolibrios.org/viewtopic.php?f=40&t=2460 Forum thread about polarSSL], [http://websvn.kolibrios.org/listing.php?repname=Kolibri+OS&path=%2Fprograms%2Fdevelop%2Flibraries%2Fhttp%2F&#a12c8a35f2062865521028a57a419b4e8 HTTP library on WebSVN]
 
  
 
=== Miscellanous / Crazy Ideas ===
 
=== Miscellanous / Crazy Ideas ===
 
These ideas are not necessarily suited for a GSoC project but I think would be good to have.<br>
 
These ideas are not necessarily suited for a GSoC project but I think would be good to have.<br>
−
 
−
==== Combine Forum Chat and IRC ====
 
−
'''Summary:''' Transfer Forum Chat messages to IRC and IRC messages to Forum Chat.
 
−
'''Details:'''
 
−
* Background: It would help keep the growing KolibriOS community together. It would also be useful for developers as they can have IRC alerts built into IRC clients but no alerts for Forum Chat. I already wrote an IRC bot for #kolibriOS based on Willie and it would be desirable to integrate this feature with that bot.
 
−
 
−
* Language: Python for IRC Bot / Not sure about Forum Chat watching (Maybe Selenium script?)
 
−
* Skill level: beginner / intermediate / learner : want to learn about this stuff
 
−
* Importance: High
 
−
* Mentors: ashmew2
 
−
* Links: [https://github.com/ashmew2/IRCBot IRC Bot Source Code]
 
  
 
<!--
 
<!--
 
  === Open Ideas (without appointed mentor) ===
 
  === Open Ideas (without appointed mentor) ===
−
 
−
==== One core for graphics ====
 
−
'''Summary:''' On multi-core systems, dedicate one core for graphics rendering ONLY
 
−
 
−
'''Details:'''
 
−
* Goal: Move graphics subsystem to a single, dedicated core if multicore machine detected
 
−
* Language: Assembler/FASM
 
−
* Skill level: intermediate/advanced
 
−
* Mentor: Serge(?)
 
−
 
−
==== Partition editor ====
 
−
'''Summary:''' Add a partition/HDD editor utility
 
−
 
−
'''Details:'''
 
−
* Language: Assembler/FASM
 
−
* Skill level: intermediate/advanced
 
−
* Mentor: Mario(?)
 
  
 
==== Rewrite "Table" in Assembler ====
 
==== Rewrite "Table" in Assembler ====
Line 515: Line 277:
 
* Skill level: beginner/intermediate/advanced
 
* Skill level: beginner/intermediate/advanced
 
* Mentor: ???
 
* Mentor: ???
−
 
−
==== Kernel vulnerabilities ====
 
−
'''Summary:''' Find and fix as many kernel vulnerabilities as you can
 
−
 
−
'''Details:'''
 
−
* Goal: Check the list of kernel API functions versus their actual implementation in KolibriOS kernel (for example, check that the function doesn't destroy register values if it declares in description that it doesn't). If you find a vulnerability, try to fix it so that it works according to API. If you cannot fix it yourself, document the vulnerability and describe the problem.
 
−
* Language: Assembler/FASM
 
−
* Skill level: Intermediate/Expert
 
−
* Mentor: Serge '''(Is not always available to answer questions, so select this task only if you can work fairly independently.)'''
 
−
 
−
==== Web browser in FASM ====
 
−
'''Summary:''' Write a proper HTML web browser for KolibriOS
 
−
 
−
'''Links:'''
 
−
* [http://www.w3.org/TR/REC-html40/ HTML 4.01 Specification]
 
−
 
−
'''Details:'''
 
−
* Primary goal: Have mostly complete HTML4 support on a good enough level to read non-complex (mobile?) websites
 
−
* Secondary goal: Add certain elements of CSS, speed optimizations
 
−
* Language: Assembler/FASM
 
−
* Skill level: Expert
 
−
* Mentor: SoUrcerer
 
−
 
−
 
−
==== Printing/scanning API ====
 
−
'''Summary:''' Add a printing and scanning API and drivers.
 
−
 
−
'''Details:'''
 
−
* Primary goal: Design and code infrastructure for printing and scanning devices.
 
−
* Language: Assembler/FASM
 
−
* Skill level: intermediate/advanced
 
−
* Mentor: SoUrcerer
 
 
-->
 
-->
  

Revision as of 00:55, 26 January 2017

Introduction

KolibriOS is going to apply as a mentoring organization for Google Summer of Code 2017. This page contains our ideas list and some additional information for students and mentors.

Why we participate? Goals?

Why this application is distinct?

We have previously successfully participated as a Mentoring Organization in Google Summer of Code in 2014 and 2016. Historical links to these events are available for your reference:


We are optimistic and therefore always discovering oportunities for further development of KolibriOS. In 2013, we have run an independent Summer of Code using money we collected with Kickstarter. Two students have worked on KolibriOS, and the results of 2013 Summer of Code were: adding write support for EXT2 filesystem, and adding (read-only) support for XFS filesystem.

To our great delight, most successful students of GSoC stayed with the project and continue contributing to KolibriOS voluntarily in their spare time.

Student Requirements

Prospective students are required to register on our developers forum, register yourself as a student, join the developers chat and submit a small bugfix / improvement to our SVN in order for their application to be considered. Examples of such tasks can be obtained by asking on developers chat or on our IRC channel (#kolibrios @ irc.freenode.net). This requirement is only to show us that you are able to work with our SVN and interact with our developers if you are selected. This task has to be completed before student application deadline (03 April 16:00 UTC).

In addition, students need to answer the following questions when applying:

  1. Full Name (First + Last Name).
  2. E-mail address.
  3. Phone (home or mobile).
  4. Another phone for emergency cases (if we cannot contact you) - parents, boy/girlfriend, husband/wife etc.
  5. Nickname you plan to use on our forums, SVN repository or IRC chat.
  6. Age.
  7. Country + city of residence.
  8. Human languages you speak (state all languages and knowledge level - basic/intermediate/expert/mother tongue).
  9. Name of college or university you are accepted into or enrolled in + link to their website.
  10. Name of program (or faculty, or department) in that college/university you are accepted into or enrolled in.
  11. Your current timezone in UTC/GMT terms (for example, Paris is UTC/GMT +1 hours right now).
  12. Have you been involved with any open-source project in the past? If yes, which one, and what have you done for that project?
  13. Code samples - please provide links to code that you have written. It can be your high school project, contribution to open-source organization, your college/university task or anything like that.
  14. The task you are willing to work on from our list of Summer of Code 2017 ideas (or suggest your own idea, if you don't like any of the proposed ideas). Please provide an approximate work plan for your task split to 1-week intervals, as well as expected outcome of your work. This point should be detailed as much as possible, as your application would be evaluated mainly based on what you write here. You are welcome (and even encouraged!) to collaborate with potential mentors on this paragraph.
  15. What other time commitments, such as school work, university studies, another job, planned vacation, etc., will you have between May 23 and August 23 (coding period)? Please be as specific as possible. Bear in mind that GSoC is like a full-time job, so if you consider taking a summer semester at the university (with more than 1-2 courses), or intend to perform an internship or work elsewhere during the summer in addition to GSoC, you will likely be NOT accepted.

Organization

You can find the organizers on the IRC channel (#kolibrios @ irc.freenode.net) or at our forum: http://board.kolibrios.org/

Name Nickname Role
Dmitriy Smirnov Pathoswithin Administrator for GSoC, mentor
Jeffrey Amelynck hidnplayr Mentor, backup administrator
Kiril Lipatov Leency Mentor
Ashish Gupta ashmew2 Mentor
Ivan Baravy dunkaist Mentor

We have discussed "Google Summer of Code 2017" application with all active members of the KolibriOS Project Team, and selected only those 3 (three) people who have both the knowledge, the dedication, and the time to help their students during the entire summer. Each one of them was assigned to mentor projects in his area of specialization only. In a rare event when a Mentor from the above list cannot continue mentoring his student(s) due to personal circumstances, we will try to find a replacement Mentor, or ask the remaining Mentors to cover for the missing one. Additionally, there is always a number of knowledgeable members of our team hanging around our forum chat, and they will gladly answer any student questions that may arise, even if they haven't volunteered as Mentors themselves.

Most Mentors selected for this year are the same that were originally proposed for last year, and they have already proved to be responsible, helpful and knowledgeable during GSoC'2014 and GSoC'2016.

Ideas for Google Summer of Code 2017

The below list contains ideas suggested by KolibriOS team members. It is neither complete nor final.
Students are welcome (and even encouraged) to suggest their own ideas for GSoC, provided they can find a mentor amongst KolibriOS developers to guide them.

fuse driver + example, fasmg app and macros, tiny unicode library (NFC, NFD, sort, etc), AML interpreter, document viewer (zathura-like api), virt-io drivers, midi synthesizer and player, kolibri gui for fasmw text editor (has undo, supported by Tomasz Grysztar!), kfar plugin for tar, loop device driver (for iso, img, raw images, will help in partition manager development), squashfs, GIMP plugin for skin open/save (in C, Python or Scheme), brotli k(er)pack and kernel compression (+library), unit test framework (for kernel and libraries), OpenStreetMap client app,

Add info of benefits for students (per task).

Sortable list of ideas for easy navigation

Idea Name Area Required Skill Level Importance for KolibriOS Programming Language Mentor
XDXF dictionary Application Basic Low Assembler(FASM) Pathoswithin
XMPP/Jabber client Application Intermediate Medium Assembler(FASM) hidnplayr
Music player Application Advanced Medium Assembler(FASM)/C/C++ hidnplayr
Ethernet driver(s) Driver Advanced High Assembler(FASM) hidnplayr
USB device drivers Driver Expert High Assembler(FASM) hidnplayr
Widget toolkit System wide task Intermediate High Assembler(FASM) Pathoswithin
Port ScummVM Library Intermediate / Advanced Medium C / FASM hidnplayr / ashmew2

Explanation of required skill level:

  • Beginner: No knowledge at all of the topic,
  • Basic: A very basic knowledge of the topic but no professional usage,
  • Intermediate: A basic knowledge of the topic but no regular professional usage,
  • Advanced: A good knowledge of the topic and a regular professional usage,
  • Expert: a perfect knowledge of the topic and a daily professional usage.

Explanation of importance for the project:

  • Low: For sure it doesn't hurt to implement, but if nobody does it, no one will even notice.
  • Medium: Nice-to-have feature. Will improve everyday life of users and developers.
  • High: This feature is needed for the project to start being adopted by masses.

Applications

These are userspace tasks. They often require only basic knowledge of algorithms and data structures.
No specific experience is required but welcome.

XDXF dictionary

Summary: Write dictionary application with support of XDXF (XML Dictionary eXchange Format)

Details:

  • Primary goal: Write library and corresponding dictionary application
  • Additional goal: Support of other dictioinary formats
  • Language: Assembler/FASM
  • Skill level: basic
  • Importance: low
  • Mentor: Pathoswithin
  • Links: fasm xml library, XDXF format


XMPP/Jabber client

Summary: Write a XMPP/Jabber library and client for KolibriOS

Details:


Music player

Summary: Improve the current music player in Kolibri

Details:

  • Primary goal: Rewrite the current music player (ac97snd), in FASM, and improve its functionality
  • Support for file formats wav, mp3 and xm (using available external libraries)
  • Support for playlists (m3u)
  • A time display
  • Additional goal:
  • Use of system wide hotkeys to control player
  • Support for metadata (ID3, ...)
  • More codecs (flac, vorbis, ...)
  • Audio indication (oscillograph, bar graph, ...)
  • Show cover art from files or album folder
  • Fade in/out and/or crossover
  • Streaming radio (at least mp3 over http stream)
  • Skins
  • Media library


Port ScummVM

Summary: Port ScummVM to KolibriOS.

Details:

  • Primary goal: Port ScummVM to KolibriOS so that users can enjoy a wide range of already available software that runs on it.
  • Secondary goal: Optimize for KolibriOS
  • Language: C / FASM
  • Skill level: intermediate / advanced
  • Importance: Medium
  • Mentors: hidnplayr / ashmew2

Links:

Drivers

Writing drivers is about supporting new hardware and filesystems.
Knowledge of specifications and previous experience are not required but surely desirable.

Ethernet driver(s)

Summary: Write an Ethernet driver

Details:


USB devices

Summary: Add USB drivers for the new USB stack (webcams, gamepads, joysticks, tablets, etc.)

Details:

  • Primary goal: Write USB driver for currently unsupported device (you should have one)
  • Additional goal: Adopt code to work with all devices of the same class
  • Language: Assembler/FASM
  • Skill level: Expert
  • Importance: High
  • Mentor: hidnplayr
  • Links: USB device classes


System wide tasks

These tasks comprise both user space and kernel space work. Some developers consider them as of most importance for KolibriOS.
Architecture and algorithm design skills are highly desirable.

Widget toolkit

Summary: Extend Box_lib (a set of separate widgets) to create a full-featured widget toolkit

Details:

  • Primary goal: Design architecture and implement focus handling, callbacks and other core ideas
  • Additional goal: Integrate box_lib widgets to this framework
  • Language: Assembler/FASM
  • Skill level: beginner/intermediate/advanced
  • Importance: High
  • Mentor: Pathoswithin
  • Links: basic idea, list of toolkits


Miscellanous / Crazy Ideas

These ideas are not necessarily suited for a GSoC project but I think would be good to have.

Rough Guide for Prospective Students

  • As the kernel is written in FASM, ability to write and understand i386-assembly code is very useful.
  • C is also a plus as some applications/libraries and components are written in C. Also, C is useful to interface with assembly at times.
  • Familiarity with the GNu landscape like Autotools, GCC etc are also a plus to have (especially for porting software)
  • The desire to take challenging problems and solve them is also required as several parts of the code base require thought for design and implementation. (The mentors can help you with that :) )
  • Hanging out on Freenode's #kolibriOS , and our Chat (accessible through kolibrios.org -> Forum -> Chat) are where developers mostly hang out.
  • Languages used for communication are Russian and English (although most developers are bilingual, and you can always ask someone for help)
  • Get in touch with other developers via IRC / Chat / Forums and enjoy your stay!

I'm a potential GSoC student. I'm scared of all the assembly and docs here! Where should I start?! :'(

Start here : http://wiki.kolibrios.org/wiki/HowTo This will help you set up KolibriOS. Easiest will be to use either Qemu or VirtualBox as most developers use it and thus will be able to help you with eventual problems. Feel free however to try something else and let us know how it goes!

I'm a potential GSoC student. What is this test task?!

Regarding the test mentioned above, it is for assessing your current skill set and their relevance regarding the project that you want to eventually work on. In most cases, your potential mentor will assign you a task via IRC / Forum Chat but another developer can do this as well . Meanwhile, In case you are waiting for a test task, you can go through our bug tracker and find a small task to work on yourself, or learn about KolibriOS by going through example code.

I want to play with the code but my college blocks SVN

If you are have trouble accessing, please do mention it on the forums. You can temporarily use this backup git repository: http://repo.or.cz/w/kolibrios.git

All the ideas seem interesting, But..

Feel free to suggest your own idea! This is encouraged largely both in GSoC and KolibriOS. The mentors will be glad to such an idea and assess it's feasibility / usability for Kolibri.

Great Guide! But I still don't understand X

Please read Documentation / Development pages on this Wiki. If you have any doubts, feel free to connect with other KolibriOS users and developers through Forum Chat or #kolibrios on Freenode. Please ask developers / mentors on Forum Chat or IRC . Please be patient on IRC and Forum Chat as developers are on different time zones and it might take a few hours to get back to you. You can also start a Forum thread if it is about something you feel is a general issue.

Most importantly...Have Fun!

Retrieved from "http://wiki.kolibrios.org/index.php?title=Google_Summer_of_Code_2017&oldid=5394"