Where is the Software Farm documentation?

Post Reply
User avatar
Cedron
Posts: 98
Joined: Thursday 21st February 2019 5:02pm
Location: The Mitten State
Contact:

Where is the Software Farm documentation?

Post by Cedron » Wednesday 24th April 2019 1:03am

I can't find it in the Wiki. I can't find any with searches. I've sort of figured it out by playing around, but where is it written about?

I am trying to decide whether to post my new gamepad code here or on the Farm. There is an enclosed (project-compiled) shared library in C that has to work correctly (compilation and referencing it).

I don't know, it depends on what Application.Path equals on an installed app.

Does Gambas honor the environment variables mentioned in https://specifications.freedesktop.org/ ... atest.html?

A lot of considerations, anybody have any preferences?
.... and carry a big stick!

User avatar
cogier
Site Admin
Posts: 296
Joined: Wednesday 21st September 2016 2:22pm
Location: Guernsey, Channel Islands

Re: Where is the Software Farm documentation?

Post by cogier » Wednesday 24th April 2019 4:07pm

Hi Cedron,

Feel free to post your code here if you wish. There is a greater chance of you getting some feed back. I have had very little feed back from items I have posted on the Farm despite putting an email address in the programs.

Make sure that it is clear to the prospective user what your program is designed to do and how to do it. So many on the Farm may be great but sometimes I have not been able to get things to work as there is no contact details nor any instructions.
Does Gambas honor the environment variables mentioned in https://specifications.freedesktop.org/ ... atest.html?
I don't know the answer to this but I know that Benoît Minisini has often refereed to freedesktop.org

User avatar
Cedron
Posts: 98
Joined: Thursday 21st February 2019 5:02pm
Location: The Mitten State
Contact:

Re: Where is the Software Farm documentation?

Post by Cedron » Thursday 25th April 2019 4:19pm

The code has been pretty much ready for a few weeks now. I've been testing, polishing, and adding some features. I want a pretty complete result when I get done, i.e. nothing pending. I also think there should be good documentation. For a library release there should also be good sample programs included.

Posting on the Farm seems like how I should be doing it, but I feel reluctant to do so. I would rather treat this forum like a "green house", get some feedback and make any improvements, so what I post will be considered complete. I am dismayed at the lack of documentation. It took me a little while to find out where "installed" programs where located.

I'm on a fairly slow (data capped) internet connection so browsing the Farm is next to useless. It takes forever for the icons to appear, and they aren't very informative. It would be nice to have a simple web page with Software Farm entries, with a description of what each does. If you know what it is supposed to do, and you have the source code, documentation isn't as necessary, but still nice to have.

Ced
.... and carry a big stick!

User avatar
cogier
Site Admin
Posts: 296
Joined: Wednesday 21st September 2016 2:22pm
Location: Guernsey, Channel Islands

Re: Where is the Software Farm documentation?

Post by cogier » Friday 26th April 2019 2:22pm

I don't know if it will help but we have the (same) Farm on this site but displayed differently. Have a look here https://gambas.one/gambasfarm/

User avatar
Cedron
Posts: 98
Joined: Thursday 21st February 2019 5:02pm
Location: The Mitten State
Contact:

Re: Where is the Software Farm documentation?

Post by Cedron » Friday 26th April 2019 9:57pm

That list is more convenient, but I don't know what tags to search on, etc. I did leave them blank and display the full list which I then saved to my hard drive.

It still seems to be a bit of a mess though. Lots of stuff, some clearly half baked, others looking good. On a positive note, when I did the "Download", I got the option of where to save the file. When I have done it from the welcome menu in Gambas it just saved without telling me where. Took me a while to find it. I'm still curious about where the official documentation for the Software Farm is supposed to be.

I've got too much stuff to work on right now, but at some point I'd like to get a copy of the database that drives that page. Is that possible?

BTW, I downloaded your piano playing program. Pretty neat. Did you record all those notes yourself? You may find this topic interesting:

https://www.dsprelated.com/thread/7902/ ... sical-note

It's about overtones of piano notes not being harmonic. I contributed a few replies at the bottom.
.... and carry a big stick!

User avatar
cogier
Site Admin
Posts: 296
Joined: Wednesday 21st September 2016 2:22pm
Location: Guernsey, Channel Islands

Re: Where is the Software Farm documentation?

Post by cogier » Saturday 27th April 2019 3:17pm

BTW, I downloaded your piano playing program. Pretty neat. Did you record all those notes yourself? You may find this topic interesting:
I didn't record all those notes! Why do that when someones already done the work? ;) If you run the Piano program and click on the 'About' button it tells you where I got them from.

My friend Matt will be coming back to you about the Farm database question as he set up the web page on Gambas.One.

User avatar
Matthew-Collins
Posts: 5
Joined: Wednesday 21st September 2016 7:59pm
Location: Guernsey, Channel Islands

Re: Where is the Software Farm documentation?

Post by Matthew-Collins » Saturday 27th April 2019 5:54pm

Hi,

My best guess is the database is a sqlite or similar on the main Gambas webserver, I'm not sure you will be able to download the raw database file...

The Gambas Farm webpage on Gambas.One is on github:
https://github.com/Matthew-Collins/gambas-farm

You can however poke the web api, see below example urls:

Get List of IDs via Search:
http://gambasfarm.org/farm/search?sort= ... hewcollins

Get Info on ID:
http://gambasfarm.org/farm/get?id=565

Get Icon from ID:
http://gambasfarm.org/farm/get?icon&id=565

Get Screen Shot from ID:
http://gambasfarm.org/farm/get?screenshot&id=565

Download Code from ID (Careful: will increment download counter):
http://gambasfarm.org/farm/download?id=565

Thanks
Matt
Cheers
Matt

User avatar
Cedron
Posts: 98
Joined: Thursday 21st February 2019 5:02pm
Location: The Mitten State
Contact:

Re: Where is the Software Farm documentation?

Post by Cedron » Monday 29th April 2019 3:35pm

Thanks Matt, that is really useful.

I'd like to see the Farm utilized as a trove of example code as well as being a source of software. Both purposes would benefit from having a way to find what you are looking for made easy.

What I have in mind is a database something like this:

Code: Select all

***********************************************
Second Draft of GambasFarmTrove Database

    Vendors     Categories
         1       1
         |       |            
         M       M
Tags    ProjectInfo
 1       1  0 1  1
 |       |  | |  |            Components
 M       M  | |  |             1      1
ProjectTags | |  |             |      |
            | |  M             M      M
       +----+ | ProjectComponents Classes
       |      |                    1 1
       M      M                    | |
SharedLibs FileInfo     +----------+ | MemberTypes 
 1  1       1 1  1      |            |  1        
 |  |    +--+ |  |      |            |  |
 |  M    M    |  M      M            M  M
 | LibUsage   | ClassUsage         Members
 |            |                     1
 M            M                     |
Functions   TextLines      +--------+
   1         1  1  1       |
   |         |  |  |       |
   M         M  |  M       M
  FunctionUsage | MemberUsage   Keywords 
                |                1 
                |        +-------+ 
                M        M
               KeywordUsage          

***********************************************
Data sources would be:

The Wiki: Components, Member, MemberTypes, and Keywords

The Farm: (All the others from a scanning)

All the relationships are oriented one to many downward so that all downward paths are one to many (outline style), upward paths are many to one , and junction (many to many) records hang as "V"s.

This is the first time I've done the database design for what I have in mind. So it is subject to change and recommendations welcome.

Imagine having a web page with all the component names in one index. You click on a component page and you see a two tier list of all the projects/files that reference the components. Each project has a checkbox next to it. Each file has a checkbox next to it. You check what you want, press the submit button, and you get a page with code excerpts of the project files surrounding the member usage.

Below the project list back on the component page is a list of all its properties, methods, and events with links. Click on one of these member links and you get a page with a project/file list of occurrences with optional code excerpts.

That is just a subset of the functionality a database like this could provide. Consider it on my to do list, but unfortunately a ways back from being gotten to. I'm putting this out there so that if anyone has the inclination and are looking for a good project to do, they can beat me to it. Please?

Ced
.... and carry a big stick!

Post Reply