Re: [jallib] Re: Proposal to restructure sample files.

Rob CJ Sun, 19 Oct 2025 08:57:50 -0700

Hi Bill,

We thought about it but it makes it bit more difficult to find your sample file 
if you have a display with keyboard for example and you may run into issues 
with naming (should CAN be a CAN directory or a BUS directory?)

I did a test splitting things up and now there are about 1800 blink sample
files in the 'blink' folder and about 1000 in the sample folder.

Kind regards,

Rob

________________________________
Van: [email protected] <[email protected]> namens Bill Beek
<[email protected]>
Verzonden: zondag 19 oktober 2025 16:09
Aan: jallib <[email protected]>
Onderwerp: Re: [jallib] Re: Proposal to restructure sample files.

Hi All,

Good Idea, for me the preference would be for proposal 3,

to limit the number of directories you can for example make

one directory "Display" with all types of displays in it etc.

A disadvantage is that a circuit with multiple functions

e.g. a display and a sensor can be found in two different dirs,

so which will result in more files in total.

Regards, Bill.

On Sunday, October 19, 2025 at 12:30:15 PM UTC+2 [email protected] wrote:

Obtenir BlueMail pour mobile<https://bluemail.me/download/>
Le 19 octobre 2025, à 10:26, vsurducan <[email protected]> a écrit:

A for me too

David

On Sun, Oct 19, 2025, 11:12 Rob CJ <[email protected]> wrote:
Hi all,

I agree with David that we should not have too may folders also because
sometimes there is only 1 sample per folder and the number of folders can
become so big that you lose oversight. This would narrow down the optiont to
two.

Question remains if we should go for (A, blink in root):
jallib/blink
jallib/compiler
jallib/doc
jallib/lib
jallib/sample

Or (B, blink in sample):
jallib/compiler
jallib/doc
jallib/lib
jallib/sample/blink
jallib/sample

Personally I like A since the blink folder is meant to provide a starting point
for each PIC for which there is a device file and so it is a bit a different
kind of sample file (it is a generated sample) and the folder structure is only
one level deep (and last but not least it fits with the current structure on
GitHub), but if the majority goes for B I am fine with that too.

And the lib directory stays indeed as it is to prevent that you need to include
more than one folder.

So should it be A or B? There is no right or wrong here, just a preference.

Thanks.

Kind regads,

Rob

________________________________
Van: [email protected] <[email protected]> namens
[email protected] <[email protected]>
Verzonden: zaterdag 18 oktober 2025 23:17
Aan: jallib <[email protected]>
Onderwerp: Re: [jallib] Re: Proposal to restructure sample files.

Obtenir BlueMail pour mobile<https://bluemail.me/download/>
Le 18 octobre 2025, à 22:59, Matthew Schinkel <[email protected]> a écrit:
Always avoid creating superfluous folder levels.
In #3, as pointed out by Rob, there will be lots of folders with only one file
in them. With a simple search in windows explorer, you immediately find those
files from the sample folder => sub folders in sample are redundant and
superfluous

The same goes for sample/blink compared to a simple blink folder in the root at
the same level as sample.

To be honest, this is how I organize the files on my PCs when downloading a new
version.

I only give my opinion, but the structure I described earlier suits me well
and I will keep it, but I will not force anyone.

However, with 3 or 4, I will have to make another script to regroup all files
again in one folder. Rob will have a lot of work to do to organize as described
in option 3, and I (and maybe other) will also have more work to regroup them
in sample. Nonsense....

Hi Rob, I vote for similar #3 but it should be one folder for each sample type.
so folders like:

blink
serial_print
large_array
dcf77_decoder_ssd1306
glcd_ssd1306_font
gps_neo_6m_ssd1306_clock

Remember this has to be generated easily without us manually placing. so I
figure if you just take for example 18f4620_fat32_small_sd_card.jal and remove
the device 18f4620 and .jal from the end, you have the folder name. You can't
put it by library name since the sample I suggested would go into folders
fat32, sd_card, print, spi and many others.

If we can't agree, just go with #1 for now, it's a good start, but there is no
need for the "other" folder.
sample/blink <-- For all blink samples
sample/ <-- For all other samples

leave device files in the lib folder, since it is a library and we would only
want to have to include one folder when compiling like jalv2.exe -s lib

Matt.

On Saturday, October 18, 2025 at 4:47:06 AM UTC-4 [email protected] wrote:
Hello,

This is posted both on the Jallib as well as the Jallist Google Group.

Matt and I had a short discussion about the directory structure of Jallib,
related to sample files.

At this moment all sample files are in the 'sample' directory. At this moment
these are almost 3000 files, most of them blink samples.

In order to find samples more easily we could organize this differently. Below
some proposals.

Proposal 0:
----------
Keep it as it is.

Proposal 1:
----------
sample/blink <-- For all blink samples
sample/other <-- For all other samples

Propsal 2:
----------
sample/blink <-- For all blink samples
sample/jal <-- For all jal samples (e.g. print, large_array, etc.)
sample/device <-- For all samples of device files

Propsal 3:
----------
sample/blink <-- For all blink samples
sample/jal <-- For all jal samples (e.g. print, large_array, etc.)
sample/ssd1306 <-- For all samples of the ssd_1306 device, one directory per
device
sample/ws2812b <-- For all samples of the ws2812b device, one directory per
device
.... <-- You do get a lot of directories, 1 for each device.

Proposal 4:
-----------
sample/blink <-- For all blink samples
sample/16f1823 <-- For all 16f1823 samples
sample/18f46q83 <-- For all 18f46q83samples
.... <-- You do get a lot of directories, 1 for each PIC type for
which there are samples

My preference is proposal 1 with the second proposal 2 where proposal 1 is the
easiest to implement since blink samples are already in a separate directory on
GitHub.

Can you let me know your thoughts about it?

Thanks.

Kind regards,

Rob

--
You received this message because you are subscribed to the Google Groups
"jallib" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/jallib/1352a88a-2735-4f6d-99e4-b85e0c35a0ddn%40googlegroups.com<https://groups.google.com/d/msgid/jallib/1352a88a-2735-4f6d-99e4-b85e0c35a0ddn%40googlegroups.com?utm_medium=email&utm_source=footer>.
--
You received this message because you are subscribed to the Google Groups
"jallib" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/jallib/e9ebabde931b98.a22f6562dd8888%40gmail.com<https://groups.google.com/d/msgid/jallib/e9ebabde931b98.a22f6562dd8888%40gmail.com?utm_medium=email&utm_source=footer>.

--
You received this message because you are subscribed to the Google Groups
"jallib" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to
[email protected]<mailto:[email protected]>.
To view this discussion visit
https://groups.google.com/d/msgid/jallib/da977c87-1a8b-4a08-a0d1-0b9c91a5dad3n%40googlegroups.com<https://groups.google.com/d/msgid/jallib/da977c87-1a8b-4a08-a0d1-0b9c91a5dad3n%40googlegroups.com?utm_medium=email&utm_source=footer>.

Re: [jallib] Re: Proposal to restructure sample files.

Reply via email to